GraphQL API Reference
How to get erxes-app-token
License
Free and open fair-code licensed under GNU General Public License v3.0 with Commons Clause.
Terms of Service
API Endpoints
# Endpoint:
https://example.com/gateway/graphql
Headers
# Create app on erxes
erxes-app-token: <YOUR_TOKEN_HERE> Queries
activityLogs
Response
Returns
[ActivityLog]
Example
Query
query ActivityLogs(
$activityType: String,
$contentId: String,
$contentType: String!,
$limit: Int
) {
activityLogs(
activityType: $activityType,
contentId: $contentId,
contentType: $contentType,
limit: $limit
) {
_id
action
content
contentDetail
contentId
contentType
contentTypeDetail
createdAt
createdBy
createdByDetail
}
}
Variables
{
"activityType": "xyz789",
"contentId": "abc123",
"contentType": "abc123",
"limit": 987
}
Response
{
"data": {
"activityLogs": [
{
"_id": "abc123",
"action": "abc123",
"content": {},
"contentDetail": {},
"contentId": "abc123",
"contentType": "abc123",
"contentTypeDetail": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdByDetail": {}
}
]
}
}
activityLogsByAction
Response
Returns an
ActivityLogByActionResponse
Example
Query
query ActivityLogsByAction(
$action: String,
$contentType: String,
$page: Int,
$perPage: Int,
$pipelineId: String
) {
activityLogsByAction(
action: $action,
contentType: $contentType,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId
) {
activityLogs {
_id
action
content
contentId
contentType
contentTypeDetail
createdAt
createdBy
createdUser {
...UserFragment
}
}
totalCount
}
}
Variables
{
"action": "abc123",
"contentType": "xyz789",
"page": 123,
"perPage": 123,
"pipelineId": "abc123"
}
Response
{
"data": {
"activityLogsByAction": {
"activityLogs": [ActivityLogByAction],
"totalCount": 123
}
}
}
allBrands
Response
Returns
[Brand]
Example
Query
query AllBrands {
allBrands {
_id
code
createdAt
description
emailConfig
name
userId
}
}
Response
{
"data": {
"allBrands": [
{
"_id": "abc123",
"code": "abc123",
"createdAt": "2007-12-03",
"description": "abc123",
"emailConfig": {},
"name": "xyz789",
"userId": "xyz789"
}
]
}
}
allLeadIntegrations
Response
Returns
[Integration]
Example
Query
query AllLeadIntegrations {
allLeadIntegrations {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Response
{
"data": {
"allLeadIntegrations": [
{
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
]
}
}
allUsers
Example
Query
query AllUsers($isActive: Boolean) {
allUsers(isActive: $isActive) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"isActive": false}
Response
{
"data": {
"allUsers": [
{
"_id": "xyz789",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "abc123",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "abc123",
"username": "xyz789"
}
]
}
}
appDetail
Example
Query
query AppDetail($_id: String) {
appDetail(_id: $_id) {
_id
accessToken
createdAt
expireDate
isEnabled
name
refreshToken
userGroupId
userGroupName
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"appDetail": {
"_id": "abc123",
"accessToken": "abc123",
"createdAt": "2007-12-03",
"expireDate": "2007-12-03",
"isEnabled": true,
"name": "abc123",
"refreshToken": "abc123",
"userGroupId": "xyz789",
"userGroupName": "xyz789"
}
}
}
apps
Response
Returns
[App]
Example
Query
query Apps {
apps {
_id
accessToken
createdAt
expireDate
isEnabled
name
refreshToken
userGroupId
userGroupName
}
}
Response
{
"data": {
"apps": [
{
"_id": "abc123",
"accessToken": "xyz789",
"createdAt": "2007-12-03",
"expireDate": "2007-12-03",
"isEnabled": false,
"name": "xyz789",
"refreshToken": "xyz789",
"userGroupId": "abc123",
"userGroupName": "abc123"
}
]
}
}
appsTotalCount
Response
Returns an
Int
Example
Query
query AppsTotalCount {
appsTotalCount
}
Response
{"data": {"appsTotalCount": 987}}
archivedDeals
Response
Returns
[Deal]
Example
Query
query ArchivedDeals(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$labelIds: [String],
$page: Int,
$perPage: Int,
$pipelineId: String!,
$priorities: [String],
$productIds: [String],
$search: String,
$startDate: String,
$userIds: [String]
) {
archivedDeals(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
labelIds: $labelIds,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId,
priorities: $priorities,
productIds: $productIds,
search: $search,
startDate: $startDate,
userIds: $userIds
) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["xyz789"],
"customerIds": ["abc123"],
"endDate": "xyz789",
"labelIds": ["abc123"],
"page": 987,
"perPage": 123,
"pipelineId": "xyz789",
"priorities": ["abc123"],
"productIds": ["xyz789"],
"search": "abc123",
"startDate": "abc123",
"userIds": ["abc123"]
}
Response
{
"data": {
"archivedDeals": [
{
"_id": "abc123",
"amount": {},
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 123.45,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "abc123",
"products": {},
"productsData": {},
"reminderMinute": 123,
"score": 987.65,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
]
}
}
archivedDealsCount
Response
Returns an
Int
Example
Query
query ArchivedDealsCount(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$labelIds: [String],
$pipelineId: String!,
$priorities: [String],
$productIds: [String],
$search: String,
$startDate: String,
$userIds: [String]
) {
archivedDealsCount(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
labelIds: $labelIds,
pipelineId: $pipelineId,
priorities: $priorities,
productIds: $productIds,
search: $search,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"assignedUserIds": ["abc123"],
"companyIds": ["xyz789"],
"customerIds": ["xyz789"],
"endDate": "xyz789",
"labelIds": ["xyz789"],
"pipelineId": "xyz789",
"priorities": ["abc123"],
"productIds": ["abc123"],
"search": "abc123",
"startDate": "abc123",
"userIds": ["xyz789"]
}
Response
{"data": {"archivedDealsCount": 987}}
archivedGrowthHacks
Response
Returns
[GrowthHack]
Arguments
| Name | Description |
|---|---|
assignedUserIds -
[String]
|
|
companyIds -
[String]
|
|
customerIds -
[String]
|
|
endDate -
String
|
|
hackStages -
[String]
|
|
labelIds -
[String]
|
|
page -
Int
|
|
perPage -
Int
|
|
pipelineId -
String!
|
|
priorities -
[String]
|
|
productIds -
[String]
|
|
search -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query ArchivedGrowthHacks(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$hackStages: [String],
$labelIds: [String],
$page: Int,
$perPage: Int,
$pipelineId: String!,
$priorities: [String],
$productIds: [String],
$search: String,
$startDate: String,
$userIds: [String]
) {
archivedGrowthHacks(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
hackStages: $hackStages,
labelIds: $labelIds,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId,
priorities: $priorities,
productIds: $productIds,
search: $search,
startDate: $startDate,
userIds: $userIds
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["abc123"],
"customerIds": ["abc123"],
"endDate": "abc123",
"hackStages": ["abc123"],
"labelIds": ["xyz789"],
"page": 123,
"perPage": 987,
"pipelineId": "xyz789",
"priorities": ["abc123"],
"productIds": ["abc123"],
"search": "abc123",
"startDate": "xyz789",
"userIds": ["xyz789"]
}
Response
{
"data": {
"archivedGrowthHacks": [
{
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"ease": 123,
"formFields": [Field],
"formId": "xyz789",
"formSubmissions": {},
"hackStages": ["abc123"],
"hasNotified": true,
"impact": 123,
"isComplete": false,
"isVoted": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reach": 987,
"reminderMinute": 123,
"score": 123.45,
"scoringType": "xyz789",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789",
"voteCount": 123,
"votedUsers": [User]
}
]
}
}
archivedGrowthHacksCount
Response
Returns an
Int
Example
Query
query ArchivedGrowthHacksCount(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$hackStages: [String],
$labelIds: [String],
$pipelineId: String!,
$priorities: [String],
$productIds: [String],
$search: String,
$startDate: String,
$userIds: [String]
) {
archivedGrowthHacksCount(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
hackStages: $hackStages,
labelIds: $labelIds,
pipelineId: $pipelineId,
priorities: $priorities,
productIds: $productIds,
search: $search,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["abc123"],
"customerIds": ["xyz789"],
"endDate": "abc123",
"hackStages": ["abc123"],
"labelIds": ["abc123"],
"pipelineId": "abc123",
"priorities": ["xyz789"],
"productIds": ["abc123"],
"search": "abc123",
"startDate": "abc123",
"userIds": ["abc123"]
}
Response
{"data": {"archivedGrowthHacksCount": 123}}
archivedStages
Response
Returns
[Stage]
Example
Query
query ArchivedStages(
$page: Int,
$perPage: Int,
$pipelineId: String!,
$search: String
) {
archivedStages(
page: $page,
perPage: $perPage,
pipelineId: $pipelineId,
search: $search
) {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
}
Variables
{
"page": 987,
"perPage": 987,
"pipelineId": "abc123",
"search": "abc123"
}
Response
{
"data": {
"archivedStages": [
{
"_id": "abc123",
"age": 123,
"amount": {},
"code": "xyz789",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["abc123"],
"formId": "xyz789",
"inProcessDealsTotalCount": 123,
"initialDealsTotalCount": 123,
"itemsTotalCount": 123,
"memberIds": ["abc123"],
"members": [User],
"name": "xyz789",
"order": 123,
"pipelineId": "abc123",
"probability": "xyz789",
"status": "abc123",
"stayedDealsTotalCount": 987,
"type": "abc123",
"visibility": "abc123"
}
]
}
}
archivedStagesCount
Example
Query
query ArchivedStagesCount(
$pipelineId: String!,
$search: String
) {
archivedStagesCount(
pipelineId: $pipelineId,
search: $search
)
}
Variables
{
"pipelineId": "abc123",
"search": "abc123"
}
Response
{"data": {"archivedStagesCount": 987}}
archivedTasks
Response
Returns
[Task]
Example
Query
query ArchivedTasks(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$labelIds: [String],
$page: Int,
$perPage: Int,
$pipelineId: String!,
$priorities: [String],
$search: String,
$startDate: String,
$userIds: [String]
) {
archivedTasks(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
labelIds: $labelIds,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId,
priorities: $priorities,
search: $search,
startDate: $startDate,
userIds: $userIds
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["abc123"],
"customerIds": ["xyz789"],
"endDate": "xyz789",
"labelIds": ["xyz789"],
"page": 123,
"perPage": 123,
"pipelineId": "abc123",
"priorities": ["xyz789"],
"search": "xyz789",
"startDate": "xyz789",
"userIds": ["xyz789"]
}
Response
{
"data": {
"archivedTasks": [
{
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": true,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 123,
"score": 123.45,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
]
}
}
archivedTasksCount
Response
Returns an
Int
Example
Query
query ArchivedTasksCount(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$labelIds: [String],
$pipelineId: String!,
$priorities: [String],
$search: String,
$startDate: String,
$userIds: [String]
) {
archivedTasksCount(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
labelIds: $labelIds,
pipelineId: $pipelineId,
priorities: $priorities,
search: $search,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["xyz789"],
"customerIds": ["abc123"],
"endDate": "abc123",
"labelIds": ["xyz789"],
"pipelineId": "xyz789",
"priorities": ["xyz789"],
"search": "xyz789",
"startDate": "abc123",
"userIds": ["abc123"]
}
Response
{"data": {"archivedTasksCount": 123}}
archivedTickets
Response
Returns
[Ticket]
Example
Query
query ArchivedTickets(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$labelIds: [String],
$page: Int,
$perPage: Int,
$pipelineId: String!,
$priorities: [String],
$search: String,
$sources: [String],
$startDate: String,
$userIds: [String]
) {
archivedTickets(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
labelIds: $labelIds,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId,
priorities: $priorities,
search: $search,
sources: $sources,
startDate: $startDate,
userIds: $userIds
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["abc123"],
"customerIds": ["xyz789"],
"endDate": "abc123",
"labelIds": ["abc123"],
"page": 987,
"perPage": 987,
"pipelineId": "abc123",
"priorities": ["abc123"],
"search": "xyz789",
"sources": ["abc123"],
"startDate": "xyz789",
"userIds": ["xyz789"]
}
Response
{
"data": {
"archivedTickets": [
{
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": true,
"isComplete": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 987,
"score": 987.65,
"source": "abc123",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
]
}
}
archivedTicketsCount
Response
Returns an
Int
Example
Query
query ArchivedTicketsCount(
$assignedUserIds: [String],
$companyIds: [String],
$customerIds: [String],
$endDate: String,
$labelIds: [String],
$pipelineId: String!,
$priorities: [String],
$search: String,
$sources: [String],
$startDate: String,
$userIds: [String]
) {
archivedTicketsCount(
assignedUserIds: $assignedUserIds,
companyIds: $companyIds,
customerIds: $customerIds,
endDate: $endDate,
labelIds: $labelIds,
pipelineId: $pipelineId,
priorities: $priorities,
search: $search,
sources: $sources,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"assignedUserIds": ["xyz789"],
"companyIds": ["xyz789"],
"customerIds": ["xyz789"],
"endDate": "abc123",
"labelIds": ["xyz789"],
"pipelineId": "abc123",
"priorities": ["abc123"],
"search": "abc123",
"sources": ["xyz789"],
"startDate": "abc123",
"userIds": ["xyz789"]
}
Response
{"data": {"archivedTicketsCount": 123}}
automationConfigPrievewCount
automationDetail
Response
Returns an
Automation
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query AutomationDetail($_id: String!) {
automationDetail(_id: $_id) {
_id
actions {
config
description
icon
id
label
nextActionId
style
type
}
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
status
triggers {
actionId
config
count
description
icon
id
label
style
type
}
updatedAt
updatedBy
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"automationDetail": {
"_id": "xyz789",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"name": "abc123",
"status": "abc123",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "xyz789",
"updatedUser": User
}
}
}
automationHistories
Response
Returns
[AutomationHistory]
Example
Query
query AutomationHistories(
$automationId: String!,
$beginDate: Date,
$endDate: Date,
$page: Int,
$perPage: Int,
$status: String,
$triggerId: String,
$triggerType: String
) {
automationHistories(
automationId: $automationId,
beginDate: $beginDate,
endDate: $endDate,
page: $page,
perPage: $perPage,
status: $status,
triggerId: $triggerId,
triggerType: $triggerType
) {
_id
actions
automationId
createdAt
description
modifiedAt
nextActionId
startWaitingDate
status
target
targetId
triggerConfig
triggerId
triggerType
waitingActionId
}
}
Variables
{
"automationId": "abc123",
"beginDate": "2007-12-03",
"endDate": "2007-12-03",
"page": 123,
"perPage": 123,
"status": "abc123",
"triggerId": "abc123",
"triggerType": "abc123"
}
Response
{
"data": {
"automationHistories": [
{
"_id": "abc123",
"actions": [{}],
"automationId": "abc123",
"createdAt": "2007-12-03",
"description": "abc123",
"modifiedAt": "2007-12-03",
"nextActionId": "xyz789",
"startWaitingDate": "2007-12-03",
"status": "xyz789",
"target": {},
"targetId": "xyz789",
"triggerConfig": {},
"triggerId": "abc123",
"triggerType": "xyz789",
"waitingActionId": "abc123"
}
]
}
}
automationNotes
Response
Returns
[AutomationNote]
Example
Query
query AutomationNotes(
$actionId: String,
$automationId: String!,
$triggerId: String
) {
automationNotes(
actionId: $actionId,
automationId: $automationId,
triggerId: $triggerId
) {
_id
actionId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
triggerId
}
}
Variables
{
"actionId": "abc123",
"automationId": "xyz789",
"triggerId": "xyz789"
}
Response
{
"data": {
"automationNotes": [
{
"_id": "abc123",
"actionId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "abc123",
"triggerId": "abc123"
}
]
}
}
automations
Response
Returns
[Automation]
Example
Query
query Automations(
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String
) {
automations(
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status
) {
_id
actions {
config
description
icon
id
label
nextActionId
style
type
}
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
status
triggers {
actionId
config
count
description
icon
id
label
style
type
}
updatedAt
updatedBy
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"excludeIds": false,
"ids": ["abc123"],
"page": 123,
"perPage": 987,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "xyz789",
"status": "xyz789"
}
Response
{
"data": {
"automations": [
{
"_id": "abc123",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"name": "xyz789",
"status": "abc123",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "xyz789",
"updatedUser": User
}
]
}
}
automationsMain
Response
Returns an
AutomationsListResponse
Example
Query
query AutomationsMain(
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String
) {
automationsMain(
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status
) {
list {
_id
actions {
...ActionFragment
}
createdAt
createdBy
createdUser {
...UserFragment
}
name
status
triggers {
...TriggerFragment
}
updatedAt
updatedBy
updatedUser {
...UserFragment
}
}
totalCount
}
}
Variables
{
"excludeIds": false,
"ids": ["xyz789"],
"page": 123,
"perPage": 123,
"searchValue": "abc123",
"sortDirection": 987,
"sortField": "abc123",
"status": "abc123"
}
Response
{
"data": {
"automationsMain": {
"list": [Automation],
"totalCount": 123.45
}
}
}
automationsTotalCount
Response
Returns an
automationsTotalCountResponse
Arguments
| Name | Description |
|---|---|
status -
String
|
Example
Query
query AutomationsTotalCount($status: String) {
automationsTotalCount(status: $status) {
byStatus
total
}
}
Variables
{"status": "abc123"}
Response
{"data": {"automationsTotalCount": {"byStatus": 123, "total": 987}}}
boardContentTypeDetail
Example
Query
query BoardContentTypeDetail(
$contentId: String,
$contentType: String
) {
boardContentTypeDetail(
contentId: $contentId,
contentType: $contentType
)
}
Variables
{
"contentId": "xyz789",
"contentType": "xyz789"
}
Response
{"data": {"boardContentTypeDetail": {}}}
boardCounts
Response
Returns
[BoardCount]
Arguments
| Name | Description |
|---|---|
type -
String!
|
Example
Query
query BoardCounts($type: String!) {
boardCounts(type: $type) {
_id
count
name
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"boardCounts": [
{
"_id": "xyz789",
"count": 123,
"name": "abc123"
}
]
}
}
boardDetail
Example
Query
query BoardDetail($_id: String!) {
boardDetail(_id: $_id) {
_id
createdAt
name
order
pipelines {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
type
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"boardDetail": {
"_id": "xyz789",
"createdAt": "2007-12-03",
"name": "abc123",
"order": 987,
"pipelines": [Pipeline],
"type": "abc123"
}
}
}
boardGetLast
Example
Query
query BoardGetLast($type: String!) {
boardGetLast(type: $type) {
_id
createdAt
name
order
pipelines {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
type
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"boardGetLast": {
"_id": "xyz789",
"createdAt": "2007-12-03",
"name": "abc123",
"order": 123,
"pipelines": [Pipeline],
"type": "abc123"
}
}
}
boardLogs
Response
Returns a
JSON
Example
Query
query BoardLogs(
$action: String,
$content: JSON,
$contentId: String,
$contentType: String
) {
boardLogs(
action: $action,
content: $content,
contentId: $contentId,
contentType: $contentType
)
}
Variables
{
"action": "xyz789",
"content": {},
"contentId": "abc123",
"contentType": "xyz789"
}
Response
{"data": {"boardLogs": {}}}
boards
Example
Query
query Boards($type: String!) {
boards(type: $type) {
_id
createdAt
name
order
pipelines {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
type
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"boards": [
{
"_id": "xyz789",
"createdAt": "2007-12-03",
"name": "xyz789",
"order": 987,
"pipelines": [Pipeline],
"type": "abc123"
}
]
}
}
branchDetail
Example
Query
query BranchDetail($_id: String!) {
branchDetail(_id: $_id) {
_id
address
children {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
code
coordinate {
latitude
longitude
}
email
image {
duration
name
size
type
url
}
links
parent {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
parentId
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"branchDetail": {
"_id": "abc123",
"address": "abc123",
"children": [Branch],
"code": "xyz789",
"coordinate": Coordinate,
"email": "xyz789",
"image": Attachment,
"links": {},
"parent": Branch,
"parentId": "xyz789",
"phoneNumber": "xyz789",
"supervisor": User,
"supervisorId": "abc123",
"title": "abc123",
"userIds": ["abc123"],
"users": [User]
}
}
}
branches
Example
Query
query Branches($searchValue: String) {
branches(searchValue: $searchValue) {
_id
address
children {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
code
coordinate {
latitude
longitude
}
email
image {
duration
name
size
type
url
}
links
parent {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
parentId
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"searchValue": "xyz789"}
Response
{
"data": {
"branches": [
{
"_id": "abc123",
"address": "abc123",
"children": [Branch],
"code": "xyz789",
"coordinate": Coordinate,
"email": "xyz789",
"image": Attachment,
"links": {},
"parent": Branch,
"parentId": "xyz789",
"phoneNumber": "abc123",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userIds": ["xyz789"],
"users": [User]
}
]
}
}
brandDetail
Example
Query
query BrandDetail($_id: String!) {
brandDetail(_id: $_id) {
_id
code
createdAt
description
emailConfig
name
userId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"brandDetail": {
"_id": "abc123",
"code": "xyz789",
"createdAt": "2007-12-03",
"description": "abc123",
"emailConfig": {},
"name": "xyz789",
"userId": "xyz789"
}
}
}
brands
Example
Query
query Brands(
$page: Int,
$perPage: Int,
$searchValue: String
) {
brands(
page: $page,
perPage: $perPage,
searchValue: $searchValue
) {
_id
code
createdAt
description
emailConfig
name
userId
}
}
Variables
{
"page": 123,
"perPage": 123,
"searchValue": "xyz789"
}
Response
{
"data": {
"brands": [
{
"_id": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"description": "xyz789",
"emailConfig": {},
"name": "xyz789",
"userId": "abc123"
}
]
}
}
brandsGetLast
Response
Returns a
Brand
Example
Query
query BrandsGetLast {
brandsGetLast {
_id
code
createdAt
description
emailConfig
name
userId
}
}
Response
{
"data": {
"brandsGetLast": {
"_id": "abc123",
"code": "xyz789",
"createdAt": "2007-12-03",
"description": "abc123",
"emailConfig": {},
"name": "abc123",
"userId": "abc123"
}
}
}
brandsTotalCount
Response
Returns an
Int
Example
Query
query BrandsTotalCount {
brandsTotalCount
}
Response
{"data": {"brandsTotalCount": 123}}
cardsFields
Response
Returns a
JSON
Example
Query
query CardsFields {
cardsFields
}
Response
{"data": {"cardsFields": {}}}
channelDetail
Example
Query
query ChannelDetail($_id: String!) {
channelDetail(_id: $_id) {
_id
conversationCount
createdAt
description
integrationIds
integrations {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
openConversationCount
userId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"channelDetail": {
"_id": "xyz789",
"conversationCount": 987,
"createdAt": "2007-12-03",
"description": "abc123",
"integrationIds": ["abc123"],
"integrations": [Integration],
"memberIds": ["abc123"],
"members": [User],
"name": "xyz789",
"openConversationCount": 987,
"userId": "xyz789"
}
}
}
channels
Example
Query
query Channels(
$memberIds: [String],
$page: Int,
$perPage: Int
) {
channels(
memberIds: $memberIds,
page: $page,
perPage: $perPage
) {
_id
conversationCount
createdAt
description
integrationIds
integrations {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
openConversationCount
userId
}
}
Variables
{
"memberIds": ["abc123"],
"page": 987,
"perPage": 123
}
Response
{
"data": {
"channels": [
{
"_id": "abc123",
"conversationCount": 987,
"createdAt": "2007-12-03",
"description": "xyz789",
"integrationIds": ["abc123"],
"integrations": [Integration],
"memberIds": ["abc123"],
"members": [User],
"name": "xyz789",
"openConversationCount": 987,
"userId": "abc123"
}
]
}
}
channelsByMembers
Example
Query
query ChannelsByMembers($memberIds: [String]) {
channelsByMembers(memberIds: $memberIds) {
_id
conversationCount
createdAt
description
integrationIds
integrations {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
openConversationCount
userId
}
}
Variables
{"memberIds": ["abc123"]}
Response
{
"data": {
"channelsByMembers": [
{
"_id": "abc123",
"conversationCount": 987,
"createdAt": "2007-12-03",
"description": "abc123",
"integrationIds": ["xyz789"],
"integrations": [Integration],
"memberIds": ["xyz789"],
"members": [User],
"name": "xyz789",
"openConversationCount": 987,
"userId": "xyz789"
}
]
}
}
channelsGetLast
Response
Returns a
Channel
Example
Query
query ChannelsGetLast {
channelsGetLast {
_id
conversationCount
createdAt
description
integrationIds
integrations {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
openConversationCount
userId
}
}
Response
{
"data": {
"channelsGetLast": {
"_id": "abc123",
"conversationCount": 123,
"createdAt": "2007-12-03",
"description": "xyz789",
"integrationIds": ["abc123"],
"integrations": [Integration],
"memberIds": ["abc123"],
"members": [User],
"name": "abc123",
"openConversationCount": 123,
"userId": "xyz789"
}
}
}
channelsTotalCount
Response
Returns an
Int
Example
Query
query ChannelsTotalCount {
channelsTotalCount
}
Response
{"data": {"channelsTotalCount": 987}}
chatDetail
Example
Query
query ChatDetail($_id: String!) {
chatDetail(_id: $_id) {
_id
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
isSeen
lastMessage {
_id
attachments
content
createdAt
createdUser {
...UserFragment
}
isPinned
mentionedUserIds
relatedMessage {
...ChatMessageFragment
}
seenList {
...SeenInfoFragment
}
}
name
participantUsers {
_id
details {
...ChatUserDetailsFragment
}
email
isAdmin
username
}
type
visibility
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"chatDetail": {
"_id": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "abc123",
"isSeen": false,
"lastMessage": ChatMessage,
"name": "abc123",
"participantUsers": [ChatUser],
"type": "xyz789",
"visibility": "xyz789"
}
}
}
chatMessageDetail
Response
Returns a
ChatMessage
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
query ChatMessageDetail($_id: String) {
chatMessageDetail(_id: $_id) {
_id
attachments
content
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
isPinned
mentionedUserIds
relatedMessage {
_id
attachments
content
createdAt
createdUser {
...UserFragment
}
isPinned
mentionedUserIds
relatedMessage {
...ChatMessageFragment
}
seenList {
...SeenInfoFragment
}
}
seenList {
lastSeenMessageId
seenDate
user {
...UserFragment
}
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"chatMessageDetail": {
"_id": "xyz789",
"attachments": {},
"content": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"isPinned": true,
"mentionedUserIds": ["abc123"],
"relatedMessage": ChatMessage,
"seenList": [SeenInfo]
}
}
}
chatMessages
Response
Returns a
ChatMessageResponse
Example
Query
query ChatMessages(
$chatId: String,
$isPinned: Boolean,
$limit: Int,
$skip: Int
) {
chatMessages(
chatId: $chatId,
isPinned: $isPinned,
limit: $limit,
skip: $skip
) {
list {
_id
attachments
content
createdAt
createdUser {
...UserFragment
}
isPinned
mentionedUserIds
relatedMessage {
...ChatMessageFragment
}
seenList {
...SeenInfoFragment
}
}
totalCount
}
}
Variables
{
"chatId": "xyz789",
"isPinned": false,
"limit": 987,
"skip": 987
}
Response
{
"data": {
"chatMessages": {
"list": [ChatMessage],
"totalCount": 123
}
}
}
chats
Response
Returns a
ChatResponse
Example
Query
query Chats(
$limit: Int,
$skip: Int,
$type: ChatType
) {
chats(
limit: $limit,
skip: $skip,
type: $type
) {
list {
_id
createdAt
createdUser {
...UserFragment
}
description
isSeen
lastMessage {
...ChatMessageFragment
}
name
participantUsers {
...ChatUserFragment
}
type
visibility
}
totalCount
}
}
Variables
{"limit": 987, "skip": 987, "type": "direct"}
Response
{"data": {"chats": {"list": [Chat], "totalCount": 123}}}
checkLoyalties
Response
Returns a
JSON
Example
Query
query CheckLoyalties(
$ownerId: String,
$ownerType: String,
$products: JSON
) {
checkLoyalties(
ownerId: $ownerId,
ownerType: $ownerType,
products: $products
)
}
Variables
{
"ownerId": "abc123",
"ownerType": "abc123",
"products": {}
}
Response
{"data": {"checkLoyalties": {}}}
checklistDetail
Example
Query
query ChecklistDetail($_id: String!) {
checklistDetail(_id: $_id) {
_id
contentType
contentTypeId
createdDate
createdUserId
items {
_id
checklistId
content
isChecked
order
}
percent
title
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"checklistDetail": {
"_id": "abc123",
"contentType": "abc123",
"contentTypeId": "abc123",
"createdDate": "2007-12-03",
"createdUserId": "xyz789",
"items": [ChecklistItem],
"percent": 123.45,
"title": "abc123"
}
}
}
checklists
Response
Returns
[Checklist]
Example
Query
query Checklists(
$contentType: String,
$contentTypeId: String
) {
checklists(
contentType: $contentType,
contentTypeId: $contentTypeId
) {
_id
contentType
contentTypeId
createdDate
createdUserId
items {
_id
checklistId
content
isChecked
order
}
percent
title
}
}
Variables
{
"contentType": "abc123",
"contentTypeId": "xyz789"
}
Response
{
"data": {
"checklists": [
{
"_id": "xyz789",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"createdDate": "2007-12-03",
"createdUserId": "abc123",
"items": [ChecklistItem],
"percent": 987.65,
"title": "xyz789"
}
]
}
}
clientPortalConfigsTotalCount
Response
Returns an
Int
Example
Query
query ClientPortalConfigsTotalCount {
clientPortalConfigsTotalCount
}
Response
{"data": {"clientPortalConfigsTotalCount": 987}}
clientPortalCurrentUser
Response
Returns a
ClientPortalUser
Example
Query
query ClientPortalCurrentUser {
clientPortalCurrentUser {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Response
{
"data": {
"clientPortalCurrentUser": {
"_id": "xyz789",
"clientPortalId": "abc123",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "xyz789",
"erxesCustomerId": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "abc123",
"password": "xyz789",
"phone": "abc123",
"type": "abc123",
"username": "abc123"
}
}
}
clientPortalGetConfig
Response
Returns a
ClientPortal
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query ClientPortalGetConfig($_id: String!) {
clientPortalGetConfig(_id: $_id) {
_id
description
dnsStatus
domain
footerHtml
googleCredentials
headerHtml
icon
kbToggle
knowledgeBaseLabel
knowledgeBaseTopicId
logo
messengerBrandCode
mobileResponsive
name
otpConfig {
codeLength
content
emailTransporterType
smsTransporterType
}
publicTaskToggle
styles {
activeTabColor
backgroundColor
baseColor
baseFont
bodyColor
dividerColor
footerColor
headerColor
headingColor
headingFont
helpColor
linkColor
linkHoverColor
primaryBtnColor
secondaryBtnColor
}
taskBoardId
taskLabel
taskPipelineId
taskPublicBoardId
taskPublicPipelineId
taskStageId
taskToggle
ticketBoardId
ticketLabel
ticketPipelineId
ticketStageId
ticketToggle
url
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"clientPortalGetConfig": {
"_id": "xyz789",
"description": "abc123",
"dnsStatus": "xyz789",
"domain": "abc123",
"footerHtml": "abc123",
"googleCredentials": {},
"headerHtml": "abc123",
"icon": "abc123",
"kbToggle": true,
"knowledgeBaseLabel": "xyz789",
"knowledgeBaseTopicId": "abc123",
"logo": "xyz789",
"messengerBrandCode": "abc123",
"mobileResponsive": false,
"name": "abc123",
"otpConfig": OTPConfig,
"publicTaskToggle": true,
"styles": Styles,
"taskBoardId": "abc123",
"taskLabel": "xyz789",
"taskPipelineId": "abc123",
"taskPublicBoardId": "xyz789",
"taskPublicPipelineId": "abc123",
"taskStageId": "abc123",
"taskToggle": true,
"ticketBoardId": "abc123",
"ticketLabel": "xyz789",
"ticketPipelineId": "abc123",
"ticketStageId": "abc123",
"ticketToggle": false,
"url": "abc123"
}
}
}
clientPortalGetConfigByDomain
Response
Returns a
ClientPortal
Example
Query
query ClientPortalGetConfigByDomain {
clientPortalGetConfigByDomain {
_id
description
dnsStatus
domain
footerHtml
googleCredentials
headerHtml
icon
kbToggle
knowledgeBaseLabel
knowledgeBaseTopicId
logo
messengerBrandCode
mobileResponsive
name
otpConfig {
codeLength
content
emailTransporterType
smsTransporterType
}
publicTaskToggle
styles {
activeTabColor
backgroundColor
baseColor
baseFont
bodyColor
dividerColor
footerColor
headerColor
headingColor
headingFont
helpColor
linkColor
linkHoverColor
primaryBtnColor
secondaryBtnColor
}
taskBoardId
taskLabel
taskPipelineId
taskPublicBoardId
taskPublicPipelineId
taskStageId
taskToggle
ticketBoardId
ticketLabel
ticketPipelineId
ticketStageId
ticketToggle
url
}
}
Response
{
"data": {
"clientPortalGetConfigByDomain": {
"_id": "xyz789",
"description": "xyz789",
"dnsStatus": "xyz789",
"domain": "abc123",
"footerHtml": "abc123",
"googleCredentials": {},
"headerHtml": "abc123",
"icon": "abc123",
"kbToggle": false,
"knowledgeBaseLabel": "abc123",
"knowledgeBaseTopicId": "xyz789",
"logo": "xyz789",
"messengerBrandCode": "xyz789",
"mobileResponsive": true,
"name": "xyz789",
"otpConfig": OTPConfig,
"publicTaskToggle": false,
"styles": Styles,
"taskBoardId": "xyz789",
"taskLabel": "abc123",
"taskPipelineId": "abc123",
"taskPublicBoardId": "xyz789",
"taskPublicPipelineId": "xyz789",
"taskStageId": "xyz789",
"taskToggle": false,
"ticketBoardId": "abc123",
"ticketLabel": "abc123",
"ticketPipelineId": "xyz789",
"ticketStageId": "abc123",
"ticketToggle": true,
"url": "xyz789"
}
}
}
clientPortalGetConfigs
Response
Returns
[ClientPortal]
Example
Query
query ClientPortalGetConfigs(
$page: Int,
$perPage: Int
) {
clientPortalGetConfigs(
page: $page,
perPage: $perPage
) {
_id
description
dnsStatus
domain
footerHtml
googleCredentials
headerHtml
icon
kbToggle
knowledgeBaseLabel
knowledgeBaseTopicId
logo
messengerBrandCode
mobileResponsive
name
otpConfig {
codeLength
content
emailTransporterType
smsTransporterType
}
publicTaskToggle
styles {
activeTabColor
backgroundColor
baseColor
baseFont
bodyColor
dividerColor
footerColor
headerColor
headingColor
headingFont
helpColor
linkColor
linkHoverColor
primaryBtnColor
secondaryBtnColor
}
taskBoardId
taskLabel
taskPipelineId
taskPublicBoardId
taskPublicPipelineId
taskStageId
taskToggle
ticketBoardId
ticketLabel
ticketPipelineId
ticketStageId
ticketToggle
url
}
}
Variables
{"page": 987, "perPage": 987}
Response
{
"data": {
"clientPortalGetConfigs": [
{
"_id": "abc123",
"description": "abc123",
"dnsStatus": "abc123",
"domain": "abc123",
"footerHtml": "xyz789",
"googleCredentials": {},
"headerHtml": "abc123",
"icon": "abc123",
"kbToggle": true,
"knowledgeBaseLabel": "abc123",
"knowledgeBaseTopicId": "xyz789",
"logo": "abc123",
"messengerBrandCode": "xyz789",
"mobileResponsive": true,
"name": "abc123",
"otpConfig": OTPConfig,
"publicTaskToggle": true,
"styles": Styles,
"taskBoardId": "xyz789",
"taskLabel": "abc123",
"taskPipelineId": "xyz789",
"taskPublicBoardId": "xyz789",
"taskPublicPipelineId": "xyz789",
"taskStageId": "xyz789",
"taskToggle": false,
"ticketBoardId": "xyz789",
"ticketLabel": "abc123",
"ticketPipelineId": "abc123",
"ticketStageId": "abc123",
"ticketToggle": false,
"url": "xyz789"
}
]
}
}
clientPortalGetLast
Response
Returns a
ClientPortal
Example
Query
query ClientPortalGetLast {
clientPortalGetLast {
_id
description
dnsStatus
domain
footerHtml
googleCredentials
headerHtml
icon
kbToggle
knowledgeBaseLabel
knowledgeBaseTopicId
logo
messengerBrandCode
mobileResponsive
name
otpConfig {
codeLength
content
emailTransporterType
smsTransporterType
}
publicTaskToggle
styles {
activeTabColor
backgroundColor
baseColor
baseFont
bodyColor
dividerColor
footerColor
headerColor
headingColor
headingFont
helpColor
linkColor
linkHoverColor
primaryBtnColor
secondaryBtnColor
}
taskBoardId
taskLabel
taskPipelineId
taskPublicBoardId
taskPublicPipelineId
taskStageId
taskToggle
ticketBoardId
ticketLabel
ticketPipelineId
ticketStageId
ticketToggle
url
}
}
Response
{
"data": {
"clientPortalGetLast": {
"_id": "abc123",
"description": "abc123",
"dnsStatus": "abc123",
"domain": "xyz789",
"footerHtml": "abc123",
"googleCredentials": {},
"headerHtml": "xyz789",
"icon": "abc123",
"kbToggle": false,
"knowledgeBaseLabel": "abc123",
"knowledgeBaseTopicId": "xyz789",
"logo": "abc123",
"messengerBrandCode": "xyz789",
"mobileResponsive": false,
"name": "xyz789",
"otpConfig": OTPConfig,
"publicTaskToggle": true,
"styles": Styles,
"taskBoardId": "xyz789",
"taskLabel": "xyz789",
"taskPipelineId": "xyz789",
"taskPublicBoardId": "xyz789",
"taskPublicPipelineId": "abc123",
"taskStageId": "abc123",
"taskToggle": false,
"ticketBoardId": "abc123",
"ticketLabel": "xyz789",
"ticketPipelineId": "xyz789",
"ticketStageId": "abc123",
"ticketToggle": true,
"url": "abc123"
}
}
}
clientPortalGetTaskStages
Response
Returns
[Stage]
Example
Query
query ClientPortalGetTaskStages {
clientPortalGetTaskStages {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
}
Response
{
"data": {
"clientPortalGetTaskStages": [
{
"_id": "abc123",
"age": 987,
"amount": {},
"code": "abc123",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["abc123"],
"formId": "xyz789",
"inProcessDealsTotalCount": 987,
"initialDealsTotalCount": 123,
"itemsTotalCount": 123,
"memberIds": ["abc123"],
"members": [User],
"name": "abc123",
"order": 987,
"pipelineId": "abc123",
"probability": "abc123",
"status": "xyz789",
"stayedDealsTotalCount": 123,
"type": "abc123",
"visibility": "xyz789"
}
]
}
}
clientPortalGetTasks
Example
Query
query ClientPortalGetTasks($stageId: String!) {
clientPortalGetTasks(stageId: $stageId) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"stageId": "abc123"}
Response
{
"data": {
"clientPortalGetTasks": [
{
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": true,
"isComplete": true,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 123,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
]
}
}
clientPortalKnowledgeBaseArticles
Response
Returns
[KnowledgeBaseArticle]
Example
Query
query ClientPortalKnowledgeBaseArticles(
$categoryIds: [String],
$searchValue: String
) {
clientPortalKnowledgeBaseArticles(
categoryIds: $categoryIds,
searchValue: $searchValue
) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{
"categoryIds": ["abc123"],
"searchValue": "xyz789"
}
Response
{
"data": {
"clientPortalKnowledgeBaseArticles": [
{
"_id": "xyz789",
"attachments": [Attachment],
"categoryId": "abc123",
"content": "abc123",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"reactionChoices": ["xyz789"],
"reactionCounts": {},
"status": "abc123",
"summary": "xyz789",
"title": "xyz789",
"topicId": "xyz789",
"viewCount": 123
}
]
}
}
clientPortalKnowledgeBaseTopicDetail
Response
Returns a
KnowledgeBaseTopic
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query ClientPortalKnowledgeBaseTopicDetail($_id: String!) {
clientPortalKnowledgeBaseTopicDetail(_id: $_id) {
_id
backgroundImage
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
categories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
childrens {
...KnowledgeBaseCategoryFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
title
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"clientPortalKnowledgeBaseTopicDetail": {
"_id": "abc123",
"backgroundImage": "abc123",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "abc123",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"description": "xyz789",
"languageCode": "xyz789",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "xyz789"
}
}
}
clientPortalTicket
Example
Query
query ClientPortalTicket($_id: String!) {
clientPortalTicket(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"clientPortalTicket": {
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 123.45,
"source": "abc123",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
clientPortalTickets
Example
Query
query ClientPortalTickets($email: String!) {
clientPortalTickets(email: $email) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"email": "xyz789"}
Response
{
"data": {
"clientPortalTickets": [
{
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 123,
"score": 987.65,
"source": "abc123",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
]
}
}
clientPortalUserCounts
clientPortalUserDetail
Response
Returns a
ClientPortalUser
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query ClientPortalUserDetail($_id: String!) {
clientPortalUserDetail(_id: $_id) {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"clientPortalUserDetail": {
"_id": "abc123",
"clientPortalId": "abc123",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "abc123",
"erxesCustomerId": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "xyz789",
"password": "abc123",
"phone": "abc123",
"type": "xyz789",
"username": "xyz789"
}
}
}
clientPortalUsers
Response
Returns
[ClientPortalUser]
Arguments
| Name | Description |
|---|---|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
cpId -
String
|
|
excludeIds -
Boolean
|
|
ids -
[String]
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
type -
String
|
Example
Query
query ClientPortalUsers(
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$cpId: String,
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$type: String
) {
clientPortalUsers(
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
cpId: $cpId,
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
type: $type
) {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Variables
{
"conformityIsRelated": true,
"conformityIsSaved": true,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "xyz789",
"cpId": "xyz789",
"excludeIds": true,
"ids": ["xyz789"],
"page": 987,
"perPage": 123,
"searchValue": "abc123",
"sortDirection": 987,
"sortField": "abc123",
"type": "abc123"
}
Response
{
"data": {
"clientPortalUsers": [
{
"_id": "abc123",
"clientPortalId": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "xyz789",
"erxesCustomerId": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "abc123",
"password": "abc123",
"phone": "xyz789",
"type": "abc123",
"username": "abc123"
}
]
}
}
clientPortalUsersMain
Response
Returns a
clientPortalUsersListResponse
Arguments
| Name | Description |
|---|---|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
cpId -
String
|
|
excludeIds -
Boolean
|
|
ids -
[String]
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
type -
String
|
Example
Query
query ClientPortalUsersMain(
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$cpId: String,
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$type: String
) {
clientPortalUsersMain(
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
cpId: $cpId,
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
type: $type
) {
list {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
totalCount
}
}
Variables
{
"conformityIsRelated": true,
"conformityIsSaved": false,
"conformityMainType": "xyz789",
"conformityMainTypeId": "abc123",
"conformityRelType": "xyz789",
"cpId": "xyz789",
"excludeIds": true,
"ids": ["xyz789"],
"page": 123,
"perPage": 987,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "abc123",
"type": "abc123"
}
Response
{
"data": {
"clientPortalUsersMain": {
"list": [ClientPortalUser],
"totalCount": 987.65
}
}
}
commentCount
Response
Returns an
Int
Arguments
| Name | Description |
|---|---|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
Example
Query
query CommentCount(
$contentId: String!,
$contentType: ReactionContentType!
) {
commentCount(
contentId: $contentId,
contentType: $contentType
)
}
Variables
{
"contentId": "abc123",
"contentType": "exmFeed"
}
Response
{"data": {"commentCount": 123}}
comments
Response
Returns a
CommentResponse
Arguments
| Name | Description |
|---|---|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
limit -
Int
|
|
parentId -
String
|
|
skip -
Int
|
Example
Query
query Comments(
$contentId: String!,
$contentType: ReactionContentType!,
$limit: Int,
$parentId: String,
$skip: Int
) {
comments(
contentId: $contentId,
contentType: $contentType,
limit: $limit,
parentId: $parentId,
skip: $skip
) {
list {
_id
childCount
comment
contentId
contentType
createdAt
createdUser {
...UserFragment
}
parentId
updatedAt
}
totalCount
}
}
Variables
{
"contentId": "abc123",
"contentType": "exmFeed",
"limit": 123,
"parentId": "abc123",
"skip": 123
}
Response
{
"data": {
"comments": {"list": [Comment], "totalCount": 123}
}
}
companies
Response
Returns
[Company]
Arguments
| Name | Description |
|---|---|
autoCompletion -
Boolean
|
|
autoCompletionType -
String
|
|
brand -
String
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
excludeIds -
Boolean
|
|
ids -
[String]
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
segment -
String
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
tag -
String
|
Example
Query
query Companies(
$autoCompletion: Boolean,
$autoCompletionType: String,
$brand: String,
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$searchValue: String,
$segment: String,
$sortDirection: Int,
$sortField: String,
$tag: String
) {
companies(
autoCompletion: $autoCompletion,
autoCompletionType: $autoCompletionType,
brand: $brand,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
segment: $segment,
sortDirection: $sortDirection,
sortField: $sortField,
tag: $tag
) {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
emails
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
parentCompany {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
}
Variables
{
"autoCompletion": true,
"autoCompletionType": "abc123",
"brand": "abc123",
"conformityIsRelated": false,
"conformityIsSaved": false,
"conformityMainType": "abc123",
"conformityMainTypeId": "abc123",
"conformityRelType": "xyz789",
"excludeIds": true,
"ids": ["xyz789"],
"page": 123,
"perPage": 987,
"searchValue": "abc123",
"segment": "xyz789",
"sortDirection": 123,
"sortField": "xyz789",
"tag": "abc123"
}
Response
{
"data": {
"companies": [
{
"_id": "xyz789",
"avatar": "xyz789",
"businessType": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"emails": ["xyz789"],
"getTags": [Tag],
"industry": "abc123",
"isSubscribed": "abc123",
"links": {},
"location": "xyz789",
"mergedIds": ["abc123"],
"modifiedAt": "2007-12-03",
"names": ["xyz789"],
"owner": User,
"ownerId": "abc123",
"parentCompany": Company,
"parentCompanyId": "xyz789",
"phones": ["abc123"],
"plan": "xyz789",
"primaryEmail": "abc123",
"primaryName": "xyz789",
"primaryPhone": "xyz789",
"score": 987.65,
"size": 123,
"tagIds": ["xyz789"],
"trackedData": {},
"website": "xyz789"
}
]
}
}
companiesMain
Response
Returns a
CompaniesListResponse
Arguments
| Name | Description |
|---|---|
autoCompletion -
Boolean
|
|
autoCompletionType -
String
|
|
brand -
String
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
excludeIds -
Boolean
|
|
ids -
[String]
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
segment -
String
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
tag -
String
|
Example
Query
query CompaniesMain(
$autoCompletion: Boolean,
$autoCompletionType: String,
$brand: String,
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$searchValue: String,
$segment: String,
$sortDirection: Int,
$sortField: String,
$tag: String
) {
companiesMain(
autoCompletion: $autoCompletion,
autoCompletionType: $autoCompletionType,
brand: $brand,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
segment: $segment,
sortDirection: $sortDirection,
sortField: $sortField,
tag: $tag
) {
list {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
totalCount
}
}
Variables
{
"autoCompletion": false,
"autoCompletionType": "abc123",
"brand": "abc123",
"conformityIsRelated": false,
"conformityIsSaved": true,
"conformityMainType": "xyz789",
"conformityMainTypeId": "abc123",
"conformityRelType": "xyz789",
"excludeIds": false,
"ids": ["xyz789"],
"page": 123,
"perPage": 123,
"searchValue": "abc123",
"segment": "abc123",
"sortDirection": 987,
"sortField": "abc123",
"tag": "abc123"
}
Response
{
"data": {
"companiesMain": {
"list": [Company],
"totalCount": 123.45
}
}
}
companyCounts
Response
Returns a
JSON
Arguments
| Name | Description |
|---|---|
autoCompletion -
Boolean
|
|
autoCompletionType -
String
|
|
brand -
String
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
excludeIds -
Boolean
|
|
ids -
[String]
|
|
only -
String
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
segment -
String
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
tag -
String
|
Example
Query
query CompanyCounts(
$autoCompletion: Boolean,
$autoCompletionType: String,
$brand: String,
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$excludeIds: Boolean,
$ids: [String],
$only: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$segment: String,
$sortDirection: Int,
$sortField: String,
$tag: String
) {
companyCounts(
autoCompletion: $autoCompletion,
autoCompletionType: $autoCompletionType,
brand: $brand,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
excludeIds: $excludeIds,
ids: $ids,
only: $only,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
segment: $segment,
sortDirection: $sortDirection,
sortField: $sortField,
tag: $tag
)
}
Variables
{
"autoCompletion": false,
"autoCompletionType": "xyz789",
"brand": "abc123",
"conformityIsRelated": false,
"conformityIsSaved": false,
"conformityMainType": "xyz789",
"conformityMainTypeId": "xyz789",
"conformityRelType": "xyz789",
"excludeIds": true,
"ids": ["xyz789"],
"only": "xyz789",
"page": 987,
"perPage": 987,
"searchValue": "abc123",
"segment": "xyz789",
"sortDirection": 123,
"sortField": "abc123",
"tag": "abc123"
}
Response
{"data": {"companyCounts": {}}}
companyDetail
Example
Query
query CompanyDetail($_id: String!) {
companyDetail(_id: $_id) {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
emails
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
parentCompany {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"companyDetail": {
"_id": "abc123",
"avatar": "xyz789",
"businessType": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"emails": ["abc123"],
"getTags": [Tag],
"industry": "xyz789",
"isSubscribed": "abc123",
"links": {},
"location": "xyz789",
"mergedIds": ["abc123"],
"modifiedAt": "2007-12-03",
"names": ["abc123"],
"owner": User,
"ownerId": "abc123",
"parentCompany": Company,
"parentCompanyId": "abc123",
"phones": ["abc123"],
"plan": "abc123",
"primaryEmail": "xyz789",
"primaryName": "abc123",
"primaryPhone": "abc123",
"score": 987.65,
"size": 123,
"tagIds": ["xyz789"],
"trackedData": {},
"website": "xyz789"
}
}
}
configs
Response
Returns
[Config]
Example
Query
query Configs {
configs {
_id
code
value
}
}
Response
{
"data": {
"configs": [
{
"_id": "xyz789",
"code": "xyz789",
"value": {}
}
]
}
}
configsCheckActivateInstallation
configsCheckPremiumService
configsConstants
Response
Returns a
JSON
Example
Query
query ConfigsConstants {
configsConstants
}
Response
{"data": {"configsConstants": {}}}
configsGetEmailTemplate
configsGetEnv
Response
Returns an
ENV
Example
Query
query ConfigsGetEnv {
configsGetEnv {
USE_BRAND_RESTRICTIONS
}
}
Response
{
"data": {
"configsGetEnv": {
"USE_BRAND_RESTRICTIONS": "xyz789"
}
}
}
configsGetValue
configsGetVersion
contactsLogs
Response
Returns a
JSON
Example
Query
query ContactsLogs(
$action: String,
$content: JSON,
$contentId: String,
$contentType: String
) {
contactsLogs(
action: $action,
content: $content,
contentId: $contentId,
contentType: $contentType
)
}
Variables
{
"action": "abc123",
"content": {},
"contentId": "abc123",
"contentType": "xyz789"
}
Response
{"data": {"contactsLogs": {}}}
conversationCounts
Response
Returns a
JSON
Example
Query
query ConversationCounts(
$awaitingResponse: String,
$brandId: String,
$channelId: String,
$endDate: String,
$ids: [String],
$integrationType: String,
$limit: Int,
$only: String,
$participating: String,
$segment: String,
$starred: String,
$startDate: String,
$status: String,
$tag: String,
$unassigned: String
) {
conversationCounts(
awaitingResponse: $awaitingResponse,
brandId: $brandId,
channelId: $channelId,
endDate: $endDate,
ids: $ids,
integrationType: $integrationType,
limit: $limit,
only: $only,
participating: $participating,
segment: $segment,
starred: $starred,
startDate: $startDate,
status: $status,
tag: $tag,
unassigned: $unassigned
)
}
Variables
{
"awaitingResponse": "abc123",
"brandId": "abc123",
"channelId": "abc123",
"endDate": "abc123",
"ids": ["abc123"],
"integrationType": "xyz789",
"limit": 123,
"only": "abc123",
"participating": "abc123",
"segment": "abc123",
"starred": "abc123",
"startDate": "xyz789",
"status": "xyz789",
"tag": "xyz789",
"unassigned": "abc123"
}
Response
{"data": {"conversationCounts": {}}}
conversationDetail
Response
Returns a
Conversation
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query ConversationDetail($_id: String!) {
conversationDetail(_id: $_id) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"conversationDetail": {
"_id": "xyz789",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "abc123",
"callProAudio": "abc123",
"content": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "xyz789",
"facebookPost": FacebookPost,
"idleTime": 987.65,
"integration": Integration,
"integrationId": "abc123",
"isFacebookTaggedMessage": false,
"messageCount": 123,
"messages": [ConversationMessage],
"number": 123,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 123,
"readUserIds": ["abc123"],
"status": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
conversationMessage
Response
Returns a
ConversationMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query ConversationMessage($_id: String!) {
conversationMessage(_id: $_id) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"conversationMessage": {
"_id": "abc123",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "xyz789",
"contentType": "abc123",
"conversationId": "xyz789",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "xyz789",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": false,
"internal": false,
"isCustomerRead": false,
"mailData": MailData,
"mentionedUserIds": ["abc123"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
conversationMessages
Response
Returns
[ConversationMessage]
Example
Query
query ConversationMessages(
$conversationId: String!,
$getFirst: Boolean,
$limit: Int,
$skip: Int
) {
conversationMessages(
conversationId: $conversationId,
getFirst: $getFirst,
limit: $limit,
skip: $skip
) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"conversationId": "abc123",
"getFirst": true,
"limit": 987,
"skip": 987
}
Response
{
"data": {
"conversationMessages": [
{
"_id": "xyz789",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "abc123",
"contentType": "xyz789",
"conversationId": "xyz789",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "xyz789",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": false,
"internal": false,
"isCustomerRead": false,
"mailData": MailData,
"mentionedUserIds": ["xyz789"],
"messengerAppData": {},
"user": User,
"userId": "xyz789",
"videoCallData": VideoCallData
}
]
}
}
conversationMessagesTotalCount
Example
Query
query ConversationMessagesTotalCount($conversationId: String!) {
conversationMessagesTotalCount(conversationId: $conversationId)
}
Variables
{"conversationId": "xyz789"}
Response
{"data": {"conversationMessagesTotalCount": 987}}
conversations
Response
Returns
[Conversation]
Example
Query
query Conversations(
$awaitingResponse: String,
$brandId: String,
$channelId: String,
$endDate: String,
$ids: [String],
$integrationType: String,
$limit: Int,
$participating: String,
$segment: String,
$starred: String,
$startDate: String,
$status: String,
$tag: String,
$unassigned: String
) {
conversations(
awaitingResponse: $awaitingResponse,
brandId: $brandId,
channelId: $channelId,
endDate: $endDate,
ids: $ids,
integrationType: $integrationType,
limit: $limit,
participating: $participating,
segment: $segment,
starred: $starred,
startDate: $startDate,
status: $status,
tag: $tag,
unassigned: $unassigned
) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"awaitingResponse": "xyz789",
"brandId": "xyz789",
"channelId": "xyz789",
"endDate": "abc123",
"ids": ["xyz789"],
"integrationType": "abc123",
"limit": 123,
"participating": "xyz789",
"segment": "abc123",
"starred": "abc123",
"startDate": "xyz789",
"status": "abc123",
"tag": "xyz789",
"unassigned": "xyz789"
}
Response
{
"data": {
"conversations": [
{
"_id": "xyz789",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "xyz789",
"callProAudio": "xyz789",
"content": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"facebookPost": FacebookPost,
"idleTime": 123.45,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": true,
"messageCount": 123,
"messages": [ConversationMessage],
"number": 987,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 987,
"readUserIds": ["abc123"],
"status": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "xyz789",
"videoCallData": VideoCallData
}
]
}
}
conversationsGetLast
Response
Returns a
Conversation
Example
Query
query ConversationsGetLast(
$awaitingResponse: String,
$brandId: String,
$channelId: String,
$endDate: String,
$ids: [String],
$integrationType: String,
$limit: Int,
$participating: String,
$segment: String,
$starred: String,
$startDate: String,
$status: String,
$tag: String,
$unassigned: String
) {
conversationsGetLast(
awaitingResponse: $awaitingResponse,
brandId: $brandId,
channelId: $channelId,
endDate: $endDate,
ids: $ids,
integrationType: $integrationType,
limit: $limit,
participating: $participating,
segment: $segment,
starred: $starred,
startDate: $startDate,
status: $status,
tag: $tag,
unassigned: $unassigned
) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"awaitingResponse": "xyz789",
"brandId": "abc123",
"channelId": "xyz789",
"endDate": "xyz789",
"ids": ["abc123"],
"integrationType": "abc123",
"limit": 987,
"participating": "xyz789",
"segment": "xyz789",
"starred": "abc123",
"startDate": "abc123",
"status": "abc123",
"tag": "xyz789",
"unassigned": "abc123"
}
Response
{
"data": {
"conversationsGetLast": {
"_id": "xyz789",
"assignedUser": User,
"assignedUserId": "abc123",
"bookingProductId": "xyz789",
"callProAudio": "xyz789",
"content": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "xyz789",
"facebookPost": FacebookPost,
"idleTime": 123.45,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": false,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 987,
"operatorStatus": "xyz789",
"participatedUserIds": ["abc123"],
"participatedUsers": [User],
"participatorCount": 987,
"readUserIds": ["abc123"],
"status": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "xyz789",
"videoCallData": VideoCallData
}
}
}
conversationsTotalCount
Response
Returns an
Int
Example
Query
query ConversationsTotalCount(
$awaitingResponse: String,
$brandId: String,
$channelId: String,
$endDate: String,
$ids: [String],
$integrationType: String,
$limit: Int,
$participating: String,
$segment: String,
$starred: String,
$startDate: String,
$status: String,
$tag: String,
$unassigned: String
) {
conversationsTotalCount(
awaitingResponse: $awaitingResponse,
brandId: $brandId,
channelId: $channelId,
endDate: $endDate,
ids: $ids,
integrationType: $integrationType,
limit: $limit,
participating: $participating,
segment: $segment,
starred: $starred,
startDate: $startDate,
status: $status,
tag: $tag,
unassigned: $unassigned
)
}
Variables
{
"awaitingResponse": "abc123",
"brandId": "xyz789",
"channelId": "xyz789",
"endDate": "abc123",
"ids": ["xyz789"],
"integrationType": "xyz789",
"limit": 987,
"participating": "xyz789",
"segment": "xyz789",
"starred": "xyz789",
"startDate": "abc123",
"status": "xyz789",
"tag": "xyz789",
"unassigned": "abc123"
}
Response
{"data": {"conversationsTotalCount": 987}}
conversationsTotalUnreadCount
Response
Returns an
Int
Example
Query
query ConversationsTotalUnreadCount {
conversationsTotalUnreadCount
}
Response
{"data": {"conversationsTotalUnreadCount": 123}}
convertToInfo
Example
Query
query ConvertToInfo($conversationId: String!) {
convertToInfo(conversationId: $conversationId) {
dealUrl
taskUrl
ticketUrl
}
}
Variables
{"conversationId": "abc123"}
Response
{
"data": {
"convertToInfo": {
"dealUrl": "abc123",
"taskUrl": "xyz789",
"ticketUrl": "xyz789"
}
}
}
cpDonateCampaigns
Response
Returns
[DonateCampaign]
Example
Query
query CpDonateCampaigns {
cpDonateCampaigns {
_id
attachment {
duration
name
size
type
url
}
awards
createdAt
createdBy
description
donatesCount
endDate
finishDateOfUse
maxScore
modifiedAt
modifiedBy
startDate
status
title
}
}
Response
{
"data": {
"cpDonateCampaigns": [
{
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"donatesCount": 987,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
]
}
}
cpLotteryCampaigns
Response
Returns
[LotteryCampaign]
Example
Query
query CpLotteryCampaigns {
cpLotteryCampaigns {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
lotteriesCount
modifiedAt
modifiedBy
numberFormat
startDate
status
title
}
}
Response
{
"data": {
"cpLotteryCampaigns": [
{
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteriesCount": 987,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"numberFormat": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"title": "abc123"
}
]
}
}
cpSpinCampaigns
Response
Returns
[SpinCampaign]
Example
Query
query CpSpinCampaigns {
cpSpinCampaigns {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
modifiedAt
modifiedBy
spinsCount
startDate
status
title
}
}
Response
{
"data": {
"cpSpinCampaigns": [
{
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 123.45,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"spinsCount": 987,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
]
}
}
cpVoucherCampaigns
Response
Returns
[VoucherCampaign]
Example
Query
query CpVoucherCampaigns {
cpVoucherCampaigns {
_id
attachment {
duration
name
size
type
url
}
bonusCount
bonusProductId
buyScore
coupon
createdAt
createdBy
description
discountPercent
endDate
finishDateOfUse
lotteryCampaignId
lotteryCount
modifiedAt
modifiedBy
productCategoryIds
productIds
score
scoreAction
spinCampaignId
spinCount
startDate
status
title
voucherType
vouchersCount
}
}
Response
{
"data": {
"cpVoucherCampaigns": [
{
"_id": "xyz789",
"attachment": Attachment,
"bonusCount": 987.65,
"bonusProductId": "abc123",
"buyScore": 123.45,
"coupon": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"discountPercent": 987.65,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "xyz789",
"lotteryCount": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"productCategoryIds": ["abc123"],
"productIds": ["xyz789"],
"score": 123.45,
"scoreAction": "xyz789",
"spinCampaignId": "xyz789",
"spinCount": 987.65,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789",
"voucherType": "xyz789",
"vouchersCount": 123
}
]
}
}
currentUser
Response
Returns a
User
Example
Query
query CurrentUser {
currentUser {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Response
{
"data": {
"currentUser": {
"_id": "xyz789",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": true,
"isShowNotification": false,
"isSubscribed": "abc123",
"leaderBoardPosition": 987,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "xyz789",
"username": "abc123"
}
}
}
customerCounts
Response
Returns a
JSON
Arguments
| Name | Description |
|---|---|
autoCompletion -
Boolean
|
|
autoCompletionType -
String
|
|
birthDate -
Date
|
|
brand -
String
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
endDate -
String
|
|
excludeIds -
Boolean
|
|
form -
String
|
|
ids -
[String]
|
|
integration -
String
|
|
leadStatus -
String
|
|
only -
String
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
segment -
String
|
|
sex -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
source -
String
|
|
startDate -
String
|
|
tag -
String
|
|
type -
String
|
Example
Query
query CustomerCounts(
$autoCompletion: Boolean,
$autoCompletionType: String,
$birthDate: Date,
$brand: String,
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$endDate: String,
$excludeIds: Boolean,
$form: String,
$ids: [String],
$integration: String,
$leadStatus: String,
$only: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$segment: String,
$sex: Int,
$sortDirection: Int,
$sortField: String,
$source: String,
$startDate: String,
$tag: String,
$type: String
) {
customerCounts(
autoCompletion: $autoCompletion,
autoCompletionType: $autoCompletionType,
birthDate: $birthDate,
brand: $brand,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
endDate: $endDate,
excludeIds: $excludeIds,
form: $form,
ids: $ids,
integration: $integration,
leadStatus: $leadStatus,
only: $only,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
segment: $segment,
sex: $sex,
sortDirection: $sortDirection,
sortField: $sortField,
source: $source,
startDate: $startDate,
tag: $tag,
type: $type
)
}
Variables
{
"autoCompletion": false,
"autoCompletionType": "xyz789",
"birthDate": "2007-12-03",
"brand": "abc123",
"conformityIsRelated": false,
"conformityIsSaved": false,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "xyz789",
"endDate": "xyz789",
"excludeIds": false,
"form": "xyz789",
"ids": ["abc123"],
"integration": "xyz789",
"leadStatus": "abc123",
"only": "abc123",
"page": 987,
"perPage": 987,
"searchValue": "abc123",
"segment": "abc123",
"sex": 123,
"sortDirection": 987,
"sortField": "abc123",
"source": "abc123",
"startDate": "xyz789",
"tag": "abc123",
"type": "abc123"
}
Response
{"data": {"customerCounts": {}}}
customerDetail
Example
Query
query CustomerDetail($_id: String!) {
customerDetail(_id: $_id) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"customerDetail": {
"_id": "abc123",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "xyz789",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "xyz789",
"description": "abc123",
"email": "xyz789",
"emailValidationStatus": "xyz789",
"emails": ["abc123"],
"firstName": "xyz789",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "abc123",
"isOnline": false,
"isSubscribed": "abc123",
"lastName": "abc123",
"lastSeenAt": "2007-12-03",
"leadStatus": "xyz789",
"links": {},
"location": {},
"middleName": "abc123",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "xyz789",
"phone": "abc123",
"phoneValidationStatus": "abc123",
"phones": ["abc123"],
"position": "abc123",
"primaryEmail": "xyz789",
"primaryPhone": "xyz789",
"remoteAddress": "xyz789",
"score": 123.45,
"sessionCount": 123,
"sex": 123,
"state": "xyz789",
"tagIds": ["xyz789"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
}
}
customers
Response
Returns
[Customer]
Arguments
| Name | Description |
|---|---|
autoCompletion -
Boolean
|
|
autoCompletionType -
String
|
|
birthDate -
Date
|
|
brand -
String
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
endDate -
String
|
|
excludeIds -
Boolean
|
|
form -
String
|
|
ids -
[String]
|
|
integration -
String
|
|
leadStatus -
String
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
segment -
String
|
|
sex -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
startDate -
String
|
|
tag -
String
|
|
type -
String
|
Example
Query
query Customers(
$autoCompletion: Boolean,
$autoCompletionType: String,
$birthDate: Date,
$brand: String,
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$endDate: String,
$excludeIds: Boolean,
$form: String,
$ids: [String],
$integration: String,
$leadStatus: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$segment: String,
$sex: Int,
$sortDirection: Int,
$sortField: String,
$startDate: String,
$tag: String,
$type: String
) {
customers(
autoCompletion: $autoCompletion,
autoCompletionType: $autoCompletionType,
birthDate: $birthDate,
brand: $brand,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
endDate: $endDate,
excludeIds: $excludeIds,
form: $form,
ids: $ids,
integration: $integration,
leadStatus: $leadStatus,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
segment: $segment,
sex: $sex,
sortDirection: $sortDirection,
sortField: $sortField,
startDate: $startDate,
tag: $tag,
type: $type
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{
"autoCompletion": true,
"autoCompletionType": "abc123",
"birthDate": "2007-12-03",
"brand": "xyz789",
"conformityIsRelated": false,
"conformityIsSaved": false,
"conformityMainType": "xyz789",
"conformityMainTypeId": "abc123",
"conformityRelType": "xyz789",
"endDate": "abc123",
"excludeIds": false,
"form": "abc123",
"ids": ["abc123"],
"integration": "abc123",
"leadStatus": "xyz789",
"page": 123,
"perPage": 987,
"searchValue": "abc123",
"segment": "xyz789",
"sex": 123,
"sortDirection": 987,
"sortField": "abc123",
"startDate": "xyz789",
"tag": "abc123",
"type": "xyz789"
}
Response
{
"data": {
"customers": [
{
"_id": "abc123",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "xyz789",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "abc123",
"email": "xyz789",
"emailValidationStatus": "abc123",
"emails": ["abc123"],
"firstName": "abc123",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "xyz789",
"isOnline": false,
"isSubscribed": "abc123",
"lastName": "xyz789",
"lastSeenAt": "2007-12-03",
"leadStatus": "xyz789",
"links": {},
"location": {},
"middleName": "abc123",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "xyz789",
"phone": "abc123",
"phoneValidationStatus": "abc123",
"phones": ["abc123"],
"position": "xyz789",
"primaryEmail": "abc123",
"primaryPhone": "abc123",
"remoteAddress": "xyz789",
"score": 987.65,
"sessionCount": 987,
"sex": 123,
"state": "xyz789",
"tagIds": ["abc123"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
]
}
}
customersMain
Response
Returns a
CustomersListResponse
Arguments
| Name | Description |
|---|---|
autoCompletion -
Boolean
|
|
autoCompletionType -
String
|
|
birthDate -
Date
|
|
brand -
String
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
endDate -
String
|
|
excludeIds -
Boolean
|
|
form -
String
|
|
ids -
[String]
|
|
integration -
String
|
|
leadStatus -
String
|
|
page -
Int
|
|
perPage -
Int
|
|
searchValue -
String
|
|
segment -
String
|
|
sex -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
startDate -
String
|
|
tag -
String
|
|
type -
String
|
Example
Query
query CustomersMain(
$autoCompletion: Boolean,
$autoCompletionType: String,
$birthDate: Date,
$brand: String,
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$endDate: String,
$excludeIds: Boolean,
$form: String,
$ids: [String],
$integration: String,
$leadStatus: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$segment: String,
$sex: Int,
$sortDirection: Int,
$sortField: String,
$startDate: String,
$tag: String,
$type: String
) {
customersMain(
autoCompletion: $autoCompletion,
autoCompletionType: $autoCompletionType,
birthDate: $birthDate,
brand: $brand,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
endDate: $endDate,
excludeIds: $excludeIds,
form: $form,
ids: $ids,
integration: $integration,
leadStatus: $leadStatus,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
segment: $segment,
sex: $sex,
sortDirection: $sortDirection,
sortField: $sortField,
startDate: $startDate,
tag: $tag,
type: $type
) {
list {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
totalCount
}
}
Variables
{
"autoCompletion": false,
"autoCompletionType": "abc123",
"birthDate": "2007-12-03",
"brand": "xyz789",
"conformityIsRelated": true,
"conformityIsSaved": false,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "abc123",
"endDate": "abc123",
"excludeIds": false,
"form": "xyz789",
"ids": ["xyz789"],
"integration": "abc123",
"leadStatus": "xyz789",
"page": 987,
"perPage": 987,
"searchValue": "abc123",
"segment": "xyz789",
"sex": 123,
"sortDirection": 987,
"sortField": "xyz789",
"startDate": "xyz789",
"tag": "abc123",
"type": "abc123"
}
Response
{
"data": {
"customersMain": {
"list": [Customer],
"totalCount": 123.45
}
}
}
dashboardDetails
Example
Query
query DashboardDetails($_id: String!) {
dashboardDetails(_id: $_id) {
_id
childsDashboard {
_id
childsDashboard {
...DashboardFragment
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"dashboardDetails": {
"_id": "abc123",
"childsDashboard": [Dashboard],
"createdAt": "2007-12-03",
"dashboardCount": 987,
"description": "abc123",
"name": "xyz789",
"order": "abc123",
"parentId": "xyz789",
"relatedIds": ["abc123"],
"selectedMemberIds": ["xyz789"],
"visibility": "abc123"
}
}
}
dashboardFilters
dashboardInitialDatas
Response
Returns
[DashboardItem]
Arguments
| Name | Description |
|---|---|
type -
String
|
Example
Query
query DashboardInitialDatas($type: String) {
dashboardInitialDatas(type: $type) {
_id
dashboardId
isDateRange
layout
name
type
vizState
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"dashboardInitialDatas": [
{
"_id": "xyz789",
"dashboardId": "abc123",
"isDateRange": true,
"layout": "abc123",
"name": "xyz789",
"type": "abc123",
"vizState": "abc123"
}
]
}
}
dashboardItemDetail
Response
Returns a
DashboardItem
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query DashboardItemDetail($_id: String!) {
dashboardItemDetail(_id: $_id) {
_id
dashboardId
isDateRange
layout
name
type
vizState
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"dashboardItemDetail": {
"_id": "abc123",
"dashboardId": "abc123",
"isDateRange": false,
"layout": "xyz789",
"name": "xyz789",
"type": "abc123",
"vizState": "abc123"
}
}
}
dashboardItems
Response
Returns
[DashboardItem]
Arguments
| Name | Description |
|---|---|
dashboardId -
String!
|
Example
Query
query DashboardItems($dashboardId: String!) {
dashboardItems(dashboardId: $dashboardId) {
_id
dashboardId
isDateRange
layout
name
type
vizState
}
}
Variables
{"dashboardId": "xyz789"}
Response
{
"data": {
"dashboardItems": [
{
"_id": "xyz789",
"dashboardId": "abc123",
"isDateRange": false,
"layout": "abc123",
"name": "abc123",
"type": "xyz789",
"vizState": "xyz789"
}
]
}
}
dashboards
Response
Returns
[Dashboard]
Example
Query
query Dashboards(
$page: Int,
$perPage: Int
) {
dashboards(
page: $page,
perPage: $perPage
) {
_id
childsDashboard {
_id
childsDashboard {
...DashboardFragment
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
}
Variables
{"page": 123, "perPage": 123}
Response
{
"data": {
"dashboards": [
{
"_id": "abc123",
"childsDashboard": [Dashboard],
"createdAt": "2007-12-03",
"dashboardCount": 987,
"description": "xyz789",
"name": "abc123",
"order": "xyz789",
"parentId": "abc123",
"relatedIds": ["xyz789"],
"selectedMemberIds": ["xyz789"],
"visibility": "abc123"
}
]
}
}
dashboardsTotalCount
Response
Returns an
Int
Example
Query
query DashboardsTotalCount {
dashboardsTotalCount
}
Response
{"data": {"dashboardsTotalCount": 987}}
dealDetail
Example
Query
query DealDetail($_id: String!) {
dealDetail(_id: $_id) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"dealDetail": {
"_id": "abc123",
"amount": {},
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "abc123",
"products": {},
"productsData": {},
"reminderMinute": 987,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
deals
Response
Returns
[DealListItem]
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
initialStageId -
String
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
productIds -
[String]
|
|
search -
String
|
|
segment -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
stageId -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query Deals(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$initialStageId: String,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$productIds: [String],
$search: String,
$segment: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$stageId: String,
$startDate: String,
$userIds: [String]
) {
deals(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
initialStageId: $initialStageId,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
productIds: $productIds,
search: $search,
segment: $segment,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
stageId: $stageId,
startDate: $startDate,
userIds: $userIds
) {
_id
amount
assignedUsers
closeDate
companies
createdAt
customFieldsData
customers
hasNotified
isComplete
isWatched
labels
modifiedAt
name
number
priority
products
relations
score
stage
startDate
}
}
Variables
{
"_ids": ["xyz789"],
"assignedToMe": "xyz789",
"assignedUserIds": ["xyz789"],
"closeDateType": "abc123",
"companyIds": ["abc123"],
"conformityIsRelated": false,
"conformityIsSaved": true,
"conformityMainType": "abc123",
"conformityMainTypeId": "abc123",
"conformityRelType": "abc123",
"customerIds": ["xyz789"],
"date": ItemDate,
"endDate": "xyz789",
"hasStartAndCloseDate": false,
"initialStageId": "xyz789",
"labelIds": ["abc123"],
"limit": 123,
"pipelineId": "xyz789",
"priority": ["xyz789"],
"productIds": ["xyz789"],
"search": "xyz789",
"segment": "abc123",
"skip": 987,
"sortDirection": 987,
"sortField": "abc123",
"stageId": "xyz789",
"startDate": "abc123",
"userIds": ["xyz789"]
}
Response
{
"data": {
"deals": [
{
"_id": "xyz789",
"amount": {},
"assignedUsers": {},
"closeDate": "2007-12-03",
"companies": {},
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": {},
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labels": {},
"modifiedAt": "2007-12-03",
"name": "abc123",
"number": "xyz789",
"priority": "abc123",
"products": {},
"relations": {},
"score": 987.65,
"stage": {},
"startDate": "2007-12-03"
}
]
}
}
dealsTotalAmounts
Response
Returns
[TotalForType]
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
labelIds -
[String]
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
productIds -
[String]
|
|
search -
String
|
|
segment -
String
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query DealsTotalAmounts(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$labelIds: [String],
$pipelineId: String,
$priority: [String],
$productIds: [String],
$search: String,
$segment: String,
$sortDirection: Int,
$sortField: String,
$startDate: String,
$userIds: [String]
) {
dealsTotalAmounts(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
labelIds: $labelIds,
pipelineId: $pipelineId,
priority: $priority,
productIds: $productIds,
search: $search,
segment: $segment,
sortDirection: $sortDirection,
sortField: $sortField,
startDate: $startDate,
userIds: $userIds
) {
_id
currencies {
amount
name
}
name
}
}
Variables
{
"_ids": ["abc123"],
"assignedToMe": "abc123",
"assignedUserIds": ["xyz789"],
"closeDateType": "abc123",
"companyIds": ["abc123"],
"conformityIsRelated": true,
"conformityIsSaved": false,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "xyz789",
"customerIds": ["xyz789"],
"date": ItemDate,
"endDate": "xyz789",
"hasStartAndCloseDate": true,
"labelIds": ["abc123"],
"pipelineId": "abc123",
"priority": ["xyz789"],
"productIds": ["abc123"],
"search": "abc123",
"segment": "xyz789",
"sortDirection": 987,
"sortField": "xyz789",
"startDate": "abc123",
"userIds": ["abc123"]
}
Response
{
"data": {
"dealsTotalAmounts": [
{
"_id": "abc123",
"currencies": [DealTotalCurrency],
"name": "abc123"
}
]
}
}
dealsTotalCount
Response
Returns an
Int
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
initialStageId -
String
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
productIds -
[String]
|
|
search -
String
|
|
segment -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
stageId -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query DealsTotalCount(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$initialStageId: String,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$productIds: [String],
$search: String,
$segment: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$stageId: String,
$startDate: String,
$userIds: [String]
) {
dealsTotalCount(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
initialStageId: $initialStageId,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
productIds: $productIds,
search: $search,
segment: $segment,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
stageId: $stageId,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"_ids": ["xyz789"],
"assignedToMe": "abc123",
"assignedUserIds": ["xyz789"],
"closeDateType": "xyz789",
"companyIds": ["abc123"],
"conformityIsRelated": false,
"conformityIsSaved": true,
"conformityMainType": "abc123",
"conformityMainTypeId": "abc123",
"conformityRelType": "xyz789",
"customerIds": ["xyz789"],
"date": ItemDate,
"endDate": "abc123",
"hasStartAndCloseDate": false,
"initialStageId": "abc123",
"labelIds": ["xyz789"],
"limit": 123,
"pipelineId": "xyz789",
"priority": ["abc123"],
"productIds": ["xyz789"],
"search": "abc123",
"segment": "xyz789",
"skip": 987,
"sortDirection": 987,
"sortField": "xyz789",
"stageId": "xyz789",
"startDate": "abc123",
"userIds": ["xyz789"]
}
Response
{"data": {"dealsTotalCount": 123}}
departmentDetail
Response
Returns a
Department
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query DepartmentDetail($_id: String!) {
departmentDetail(_id: $_id) {
_id
childCount
children {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
code
description
parent {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
parentId
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userCount
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"departmentDetail": {
"_id": "xyz789",
"childCount": 123,
"children": [Department],
"code": "xyz789",
"description": "abc123",
"parent": Department,
"parentId": "xyz789",
"supervisor": User,
"supervisorId": "abc123",
"title": "xyz789",
"userCount": 123,
"userIds": ["xyz789"],
"users": [User]
}
}
}
departments
Response
Returns
[Department]
Arguments
| Name | Description |
|---|---|
searchValue -
String
|
Example
Query
query Departments($searchValue: String) {
departments(searchValue: $searchValue) {
_id
childCount
children {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
code
description
parent {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
parentId
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userCount
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"searchValue": "abc123"}
Response
{
"data": {
"departments": [
{
"_id": "abc123",
"childCount": 123,
"children": [Department],
"code": "xyz789",
"description": "xyz789",
"parent": Department,
"parentId": "xyz789",
"supervisor": User,
"supervisorId": "xyz789",
"title": "abc123",
"userCount": 123,
"userIds": ["xyz789"],
"users": [User]
}
]
}
}
donateCampaignDetail
Response
Returns a
DonateCampaign
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query DonateCampaignDetail($_id: String!) {
donateCampaignDetail(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
awards
createdAt
createdBy
description
donatesCount
endDate
finishDateOfUse
maxScore
modifiedAt
modifiedBy
startDate
status
title
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"donateCampaignDetail": {
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"donatesCount": 987,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 123.45,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
}
}
donateCampaigns
Response
Returns
[DonateCampaign]
Example
Query
query DonateCampaigns(
$filterStatus: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String
) {
donateCampaigns(
filterStatus: $filterStatus,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField
) {
_id
attachment {
duration
name
size
type
url
}
awards
createdAt
createdBy
description
donatesCount
endDate
finishDateOfUse
maxScore
modifiedAt
modifiedBy
startDate
status
title
}
}
Variables
{
"filterStatus": "abc123",
"page": 123,
"perPage": 123,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "xyz789"
}
Response
{
"data": {
"donateCampaigns": [
{
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "xyz789",
"donatesCount": 987,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 123.45,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"title": "abc123"
}
]
}
}
donateCampaignsCount
Example
Query
query DonateCampaignsCount(
$filterStatus: String,
$searchValue: String
) {
donateCampaignsCount(
filterStatus: $filterStatus,
searchValue: $searchValue
)
}
Variables
{
"filterStatus": "xyz789",
"searchValue": "xyz789"
}
Response
{"data": {"donateCampaignsCount": 123}}
donateDetail
Example
Query
query DonateDetail($_id: String!) {
donateDetail(_id: $_id) {
_id
awardId
campaign
campaignId
createdAt
donateScore
owner
ownerId
ownerType
usedAt
voucherCampaignId
voucherId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"donateDetail": {
"_id": "xyz789",
"awardId": "abc123",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"donateScore": 123.45,
"owner": {},
"ownerId": "abc123",
"ownerType": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "xyz789"
}
}
}
donates
Response
Returns
[Donate]
Example
Query
query Donates(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String
) {
donates(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status
) {
_id
awardId
campaign
campaignId
createdAt
donateScore
owner
ownerId
ownerType
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "abc123",
"ownerId": "abc123",
"ownerType": "abc123",
"page": 123,
"perPage": 987,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "xyz789",
"status": "xyz789"
}
Response
{
"data": {
"donates": [
{
"_id": "xyz789",
"awardId": "xyz789",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"donateScore": 123.45,
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
]
}
}
donatesMain
Response
Returns a
DonateMain
Example
Query
query DonatesMain(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String
) {
donatesMain(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status
) {
list {
_id
awardId
campaign
campaignId
createdAt
donateScore
owner
ownerId
ownerType
usedAt
voucherCampaignId
voucherId
}
totalCount
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "abc123",
"ownerType": "abc123",
"page": 987,
"perPage": 123,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "xyz789",
"status": "abc123"
}
Response
{
"data": {
"donatesMain": {"list": [Donate], "totalCount": 123}
}
}
emailDeliveriesAsLogs
emailDeliveryDetail
Response
Returns an
EmailDelivery
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
query EmailDeliveryDetail($_id: String) {
emailDeliveryDetail(_id: $_id) {
_id
attachments
bcc
body
cc
createdAt
customerId
from
fromEmail
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
kind
status
subject
to
userId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"emailDeliveryDetail": {
"_id": "abc123",
"attachments": [{}],
"bcc": ["xyz789"],
"body": "abc123",
"cc": ["abc123"],
"createdAt": "2007-12-03",
"customerId": "xyz789",
"from": "xyz789",
"fromEmail": "xyz789",
"fromUser": User,
"kind": "xyz789",
"status": "xyz789",
"subject": "xyz789",
"to": ["xyz789"],
"userId": "abc123"
}
}
}
emailTemplates
Response
Returns
[EmailTemplate]
Example
Query
query EmailTemplates(
$page: Int,
$perPage: Int,
$searchValue: String,
$status: String
) {
emailTemplates(
page: $page,
perPage: $perPage,
searchValue: $searchValue,
status: $status
) {
_id
content
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
modifiedAt
name
status
}
}
Variables
{
"page": 123,
"perPage": 123,
"searchValue": "abc123",
"status": "abc123"
}
Response
{
"data": {
"emailTemplates": [
{
"_id": "xyz789",
"content": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUser": User,
"modifiedAt": "2007-12-03",
"name": "xyz789",
"status": "abc123"
}
]
}
}
emailTemplatesTotalCount
Response
Returns an
Int
Example
Query
query EmailTemplatesTotalCount {
emailTemplatesTotalCount
}
Response
{"data": {"emailTemplatesTotalCount": 123}}
emojiCount
Response
Returns an
Int
Arguments
| Name | Description |
|---|---|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
type -
String!
|
Example
Query
query EmojiCount(
$contentId: String!,
$contentType: ReactionContentType!,
$type: String!
) {
emojiCount(
contentId: $contentId,
contentType: $contentType,
type: $type
)
}
Variables
{
"contentId": "xyz789",
"contentType": "exmFeed",
"type": "xyz789"
}
Response
{"data": {"emojiCount": 123}}
emojiIsReacted
Response
Returns a
Boolean
Arguments
| Name | Description |
|---|---|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
type -
String!
|
Example
Query
query EmojiIsReacted(
$contentId: String!,
$contentType: ReactionContentType!,
$type: String!
) {
emojiIsReacted(
contentId: $contentId,
contentType: $contentType,
type: $type
)
}
Variables
{
"contentId": "abc123",
"contentType": "exmFeed",
"type": "abc123"
}
Response
{"data": {"emojiIsReacted": false}}
emojiReactedUsers
Response
Returns
[User]
Arguments
| Name | Description |
|---|---|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
type -
String!
|
Example
Query
query EmojiReactedUsers(
$contentId: String!,
$contentType: ReactionContentType!,
$type: String!
) {
emojiReactedUsers(
contentId: $contentId,
contentType: $contentType,
type: $type
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"contentId": "abc123",
"contentType": "exmFeed",
"type": "abc123"
}
Response
{
"data": {
"emojiReactedUsers": [
{
"_id": "xyz789",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["xyz789"],
"isActive": false,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "abc123",
"username": "abc123"
}
]
}
}
enabledServices
Response
Returns a
JSON
Example
Query
query EnabledServices {
enabledServices
}
Response
{"data": {"enabledServices": {}}}
engageEmailPercentages
Response
Returns an
AvgEmailStats
Example
Query
query EngageEmailPercentages {
engageEmailPercentages {
avgBouncePercent
avgClickPercent
avgComplaintPercent
avgDeliveryPercent
avgOpenPercent
avgRejectPercent
avgRenderingFailurePercent
avgSendPercent
total
}
}
Response
{
"data": {
"engageEmailPercentages": {
"avgBouncePercent": 987.65,
"avgClickPercent": 987.65,
"avgComplaintPercent": 123.45,
"avgDeliveryPercent": 123.45,
"avgOpenPercent": 123.45,
"avgRejectPercent": 987.65,
"avgRenderingFailurePercent": 123.45,
"avgSendPercent": 123.45,
"total": 123.45
}
}
}
engageLogs
Response
Returns
[EngageLog]
Example
Query
query EngageLogs(
$engageMessageId: String!,
$page: Int,
$perPage: Int
) {
engageLogs(
engageMessageId: $engageMessageId,
page: $page,
perPage: $perPage
) {
_id
createdAt
engageMessageId
message
type
}
}
Variables
{
"engageMessageId": "xyz789",
"page": 123,
"perPage": 987
}
Response
{
"data": {
"engageLogs": [
{
"_id": "abc123",
"createdAt": "2007-12-03",
"engageMessageId": "xyz789",
"message": "xyz789",
"type": "xyz789"
}
]
}
}
engageMessageCounts
Example
Query
query EngageMessageCounts(
$kind: String,
$name: String!,
$status: String
) {
engageMessageCounts(
kind: $kind,
name: $name,
status: $status
)
}
Variables
{
"kind": "abc123",
"name": "xyz789",
"status": "abc123"
}
Response
{"data": {"engageMessageCounts": {}}}
engageMessageDetail
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
query EngageMessageDetail($_id: String) {
engageMessageDetail(_id: $_id) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"engageMessageDetail": {
"_id": "xyz789",
"brand": Brand,
"brandIds": ["abc123"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUserName": "xyz789",
"customerIds": ["xyz789"],
"customerTagIds": ["abc123"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "xyz789",
"getTags": [Tag],
"isDraft": false,
"isLive": false,
"kind": "abc123",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "xyz789",
"runCount": 987,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["xyz789"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "abc123",
"totalCustomersCount": 987,
"type": "abc123",
"validCustomersCount": 123
}
}
}
engageMessages
Response
Returns
[EngageMessage]
Example
Query
query EngageMessages(
$ids: String,
$kind: String,
$page: Int,
$perPage: Int,
$status: String,
$tag: String
) {
engageMessages(
ids: $ids,
kind: $kind,
page: $page,
perPage: $perPage,
status: $status,
tag: $tag
) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{
"ids": "xyz789",
"kind": "xyz789",
"page": 987,
"perPage": 123,
"status": "abc123",
"tag": "xyz789"
}
Response
{
"data": {
"engageMessages": [
{
"_id": "xyz789",
"brand": Brand,
"brandIds": ["xyz789"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUserName": "xyz789",
"customerIds": ["xyz789"],
"customerTagIds": ["xyz789"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "abc123",
"getTags": [Tag],
"isDraft": false,
"isLive": false,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "abc123",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["abc123"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["abc123"],
"title": "xyz789",
"totalCustomersCount": 123,
"type": "abc123",
"validCustomersCount": 123
}
]
}
}
engageMessagesTotalCount
Response
Returns an
Int
Example
Query
query EngageMessagesTotalCount(
$ids: String,
$kind: String,
$page: Int,
$perPage: Int,
$status: String,
$tag: String
) {
engageMessagesTotalCount(
ids: $ids,
kind: $kind,
page: $page,
perPage: $perPage,
status: $status,
tag: $tag
)
}
Variables
{
"ids": "xyz789",
"kind": "abc123",
"page": 987,
"perPage": 987,
"status": "abc123",
"tag": "xyz789"
}
Response
{"data": {"engageMessagesTotalCount": 123}}
engageReportsList
Response
Returns an
EngageDeliveryReport
Example
Query
query EngageReportsList(
$customerId: String,
$page: Int,
$perPage: Int,
$status: String
) {
engageReportsList(
customerId: $customerId,
page: $page,
perPage: $perPage,
status: $status
) {
list {
_id
createdAt
customerId
customerName
engage {
...EngageMessageFragment
}
mailId
status
}
totalCount
}
}
Variables
{
"customerId": "abc123",
"page": 123,
"perPage": 987,
"status": "abc123"
}
Response
{
"data": {
"engageReportsList": {
"list": [DeliveryReport],
"totalCount": 987
}
}
}
engageSmsDeliveries
Response
Returns a
DeliveryList
Example
Query
query EngageSmsDeliveries(
$page: Int,
$perPage: Int,
$to: String,
$type: String!
) {
engageSmsDeliveries(
page: $page,
perPage: $perPage,
to: $to,
type: $type
) {
list {
_id
content
conversationId
createdAt
direction
engageMessageId
errorMessages
erxesApiId
from
integrationId
requestData
responseData
status
statusUpdates {
...SmsStatusFragment
}
telnyxId
to
}
totalCount
}
}
Variables
{
"page": 987,
"perPage": 987,
"to": "abc123",
"type": "abc123"
}
Response
{
"data": {
"engageSmsDeliveries": {
"list": [SmsDelivery],
"totalCount": 987
}
}
}
engageVerifiedEmails
Response
Returns
[String]
Example
Query
query EngageVerifiedEmails {
engageVerifiedEmails
}
Response
{
"data": {
"engageVerifiedEmails": ["abc123"]
}
}
engagesConfigDetail
Response
Returns a
JSON
Example
Query
query EngagesConfigDetail {
engagesConfigDetail
}
Response
{"data": {"engagesConfigDetail": {}}}
exmFeed
Response
Returns an
ExmFeedResponse
Arguments
| Name | Description |
|---|---|
contentTypes -
[ContentType]
|
|
endDate -
String
|
|
isPinned -
Boolean
|
|
limit -
Int
|
|
recipientType -
RecipientType
|
|
skip -
Int
|
|
startDate -
String
|
|
title -
String
|
|
type -
SourceType
|
Example
Query
query ExmFeed(
$contentTypes: [ContentType],
$endDate: String,
$isPinned: Boolean,
$limit: Int,
$recipientType: RecipientType,
$skip: Int,
$startDate: String,
$title: String,
$type: SourceType
) {
exmFeed(
contentTypes: $contentTypes,
endDate: $endDate,
isPinned: $isPinned,
limit: $limit,
recipientType: $recipientType,
skip: $skip,
startDate: $startDate,
title: $title,
type: $type
) {
list {
_id
attachments
ceremonyData {
...ExmCeremonyDataFragment
}
commentCount
contentType
createdAt
createdUser {
...UserFragment
}
customFieldsData
description
endDate
eventData {
...ExmEventDataFragment
}
eventGoingUsers {
...UserFragment
}
eventInterestedUsers {
...UserFragment
}
heartCount
images
isHearted
isLiked
isPinned
likeCount
recipientIds
recipients {
...UserFragment
}
startDate
title
updatedAt
updatedUser {
...UserFragment
}
visibility
where
}
totalCount
}
}
Variables
{
"contentTypes": ["birthday"],
"endDate": "abc123",
"isPinned": true,
"limit": 123,
"recipientType": "recieved",
"skip": 123,
"startDate": "xyz789",
"title": "xyz789",
"type": "admin"
}
Response
{
"data": {
"exmFeed": {"list": [ExmFeed], "totalCount": 987}
}
}
exmFeedCeremonies
Response
Returns an
ExmFeedResponse
Arguments
| Name | Description |
|---|---|
contentType -
ContentType
|
|
filterType -
FilterType
|
Example
Query
query ExmFeedCeremonies(
$contentType: ContentType,
$filterType: FilterType
) {
exmFeedCeremonies(
contentType: $contentType,
filterType: $filterType
) {
list {
_id
attachments
ceremonyData {
...ExmCeremonyDataFragment
}
commentCount
contentType
createdAt
createdUser {
...UserFragment
}
customFieldsData
description
endDate
eventData {
...ExmEventDataFragment
}
eventGoingUsers {
...UserFragment
}
eventInterestedUsers {
...UserFragment
}
heartCount
images
isHearted
isLiked
isPinned
likeCount
recipientIds
recipients {
...UserFragment
}
startDate
title
updatedAt
updatedUser {
...UserFragment
}
visibility
where
}
totalCount
}
}
Variables
{"contentType": "birthday", "filterType": "today"}
Response
{
"data": {
"exmFeedCeremonies": {
"list": [ExmFeed],
"totalCount": 123
}
}
}
exmFeedDetail
Example
Query
query ExmFeedDetail($_id: String!) {
exmFeedDetail(_id: $_id) {
_id
attachments
ceremonyData {
howManyYear
startedDate
willDate
year
}
commentCount
contentType
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
endDate
eventData {
endDate
goingUserIds
interestedUserIds
startDate
visibility
where
}
eventGoingUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
eventInterestedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
heartCount
images
isHearted
isLiked
isPinned
likeCount
recipientIds
recipients {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
startDate
title
updatedAt
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
visibility
where
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"exmFeedDetail": {
"_id": "abc123",
"attachments": {},
"ceremonyData": ExmCeremonyData,
"commentCount": 987,
"contentType": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"endDate": "2007-12-03",
"eventData": ExmEventData,
"eventGoingUsers": [User],
"eventInterestedUsers": [User],
"heartCount": 123,
"images": {},
"isHearted": true,
"isLiked": false,
"isPinned": false,
"likeCount": 123,
"recipientIds": ["abc123"],
"recipients": [User],
"startDate": "2007-12-03",
"title": "abc123",
"updatedAt": "2007-12-03",
"updatedUser": User,
"visibility": "abc123",
"where": "xyz789"
}
}
}
exmGet
Response
Returns an
Exm
Example
Query
query ExmGet {
exmGet {
_id
appearance {
primaryColor
secondaryColor
}
createdAt
createdBy
description
features {
_id
contentId
contentType
description
icon
name
subContentId
}
logo
name
welcomeContent {
_id
content
image
title
}
}
}
Response
{
"data": {
"exmGet": {
"_id": "abc123",
"appearance": ExmAppearance,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"features": [ExmFeature],
"logo": {},
"name": "abc123",
"welcomeContent": [ExmWelcomeContent]
}
}
}
exmThanks
Response
Returns an
ExmThankResponse
Arguments
| Name | Description |
|---|---|
limit -
Int
|
|
skip -
Int
|
|
type -
SourceType
|
Example
Query
query ExmThanks(
$limit: Int,
$skip: Int,
$type: SourceType
) {
exmThanks(
limit: $limit,
skip: $skip,
type: $type
) {
list {
_id
createdAt
createdUser {
...UserFragment
}
description
recipientIds
recipients {
...UserFragment
}
updatedAt
}
totalCount
}
}
Variables
{"limit": 123, "skip": 987, "type": "admin"}
Response
{
"data": {
"exmThanks": {"list": [ExmThank], "totalCount": 123}
}
}
exms
Example
Query
query Exms(
$name: String,
$page: Int,
$perPage: Int
) {
exms(
name: $name,
page: $page,
perPage: $perPage
) {
list {
_id
appearance {
...ExmAppearanceFragment
}
createdAt
createdBy
description
features {
...ExmFeatureFragment
}
logo
name
welcomeContent {
...ExmWelcomeContentFragment
}
}
totalCount
}
}
Variables
{
"name": "abc123",
"page": 987,
"perPage": 987
}
Response
{"data": {"exms": {"list": [Exm], "totalCount": 123}}}
fields
Response
Returns
[Field]
Example
Query
query Fields(
$contentType: String!,
$contentTypeId: String,
$isVisible: Boolean,
$searchable: Boolean
) {
fields(
contentType: $contentType,
contentTypeId: $contentTypeId,
isVisible: $isVisible,
searchable: $searchable
) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{
"contentType": "xyz789",
"contentTypeId": "abc123",
"isVisible": true,
"searchable": false
}
Response
{
"data": {
"fields": [
{
"_id": "abc123",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": true,
"code": "xyz789",
"column": 123,
"content": "xyz789",
"contentType": "abc123",
"contentTypeId": "abc123",
"description": "abc123",
"groupId": "abc123",
"groupName": "abc123",
"isDefinedByErxes": true,
"isRequired": true,
"isVisible": false,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "xyz789",
"locationOptions": [LocationOption],
"logicAction": "xyz789",
"logics": [Logic],
"name": "abc123",
"objectListConfigs": [ObjectListConfig],
"options": ["xyz789"],
"order": 123,
"pageNumber": 987,
"productCategoryId": "xyz789",
"products": [Product],
"searchable": false,
"showInCard": false,
"text": "xyz789",
"type": "xyz789",
"validation": "abc123"
}
]
}
}
fieldsCombinedByContentType
Response
Returns a
JSON
Example
Query
query FieldsCombinedByContentType(
$config: JSON,
$contentType: String!,
$excludedNames: [String],
$segmentId: String,
$usageType: String
) {
fieldsCombinedByContentType(
config: $config,
contentType: $contentType,
excludedNames: $excludedNames,
segmentId: $segmentId,
usageType: $usageType
)
}
Variables
{
"config": {},
"contentType": "abc123",
"excludedNames": ["abc123"],
"segmentId": "abc123",
"usageType": "abc123"
}
Response
{"data": {"fieldsCombinedByContentType": {}}}
fieldsDefaultColumnsConfig
Response
Returns
[ColumnConfigItem]
Arguments
| Name | Description |
|---|---|
contentType -
String!
|
Example
Query
query FieldsDefaultColumnsConfig($contentType: String!) {
fieldsDefaultColumnsConfig(contentType: $contentType) {
label
name
order
}
}
Variables
{"contentType": "xyz789"}
Response
{
"data": {
"fieldsDefaultColumnsConfig": [
{
"label": "xyz789",
"name": "abc123",
"order": 987
}
]
}
}
fieldsGetTypes
Response
Returns
[JSON]
Example
Query
query FieldsGetTypes {
fieldsGetTypes
}
Response
{"data": {"fieldsGetTypes": [{}]}}
fieldsGroups
Response
Returns
[FieldsGroup]
Example
Query
query FieldsGroups(
$config: JSON,
$contentType: String,
$isDefinedByErxes: Boolean
) {
fieldsGroups(
config: $config,
contentType: $contentType,
isDefinedByErxes: $isDefinedByErxes
) {
_id
code
config
contentType
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
isDefinedByErxes
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
name
order
}
}
Variables
{
"config": {},
"contentType": "xyz789",
"isDefinedByErxes": false
}
Response
{
"data": {
"fieldsGroups": [
{
"_id": "xyz789",
"code": "abc123",
"config": {},
"contentType": "xyz789",
"description": "xyz789",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": true,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"name": "abc123",
"order": 987
}
]
}
}
formDetail
Example
Query
query FormDetail($_id: String!) {
formDetail(_id: $_id) {
_id
buttonText
code
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
googleMapApiKey
numberOfPages
title
type
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"formDetail": {
"_id": "abc123",
"buttonText": "abc123",
"code": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123",
"description": "xyz789",
"fields": [Field],
"googleMapApiKey": "abc123",
"numberOfPages": 123,
"title": "abc123",
"type": "abc123"
}
}
}
formSubmissions
Response
Returns
[Submission]
Arguments
| Name | Description |
|---|---|
filters -
[SubmissionFilter]
|
|
formId -
String
|
|
page -
Int
|
|
perPage -
Int
|
|
tagId -
String
|
Example
Query
query FormSubmissions(
$filters: [SubmissionFilter],
$formId: String,
$page: Int,
$perPage: Int,
$tagId: String
) {
formSubmissions(
filters: $filters,
formId: $formId,
page: $page,
perPage: $perPage,
tagId: $tagId
) {
_id
contentTypeId
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
submissions {
_id
customerId
formFieldId
formFieldText
formId
submittedAt
text
value
}
}
}
Variables
{
"filters": [SubmissionFilter],
"formId": "xyz789",
"page": 987,
"perPage": 123,
"tagId": "abc123"
}
Response
{
"data": {
"formSubmissions": [
{
"_id": "xyz789",
"contentTypeId": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "xyz789",
"submissions": [FormSubmission]
}
]
}
}
formSubmissionsTotalCount
Response
Returns an
Int
Arguments
| Name | Description |
|---|---|
filters -
[SubmissionFilter]
|
|
formId -
String
|
|
tagId -
String
|
Example
Query
query FormSubmissionsTotalCount(
$filters: [SubmissionFilter],
$formId: String,
$tagId: String
) {
formSubmissionsTotalCount(
filters: $filters,
formId: $formId,
tagId: $tagId
)
}
Variables
{
"filters": [SubmissionFilter],
"formId": "xyz789",
"tagId": "abc123"
}
Response
{"data": {"formSubmissionsTotalCount": 123}}
forms
Response
Returns
[Form]
Example
Query
query Forms {
forms {
_id
buttonText
code
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
googleMapApiKey
numberOfPages
title
type
}
}
Response
{
"data": {
"forms": [
{
"_id": "xyz789",
"buttonText": "xyz789",
"code": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123",
"description": "abc123",
"fields": [Field],
"googleMapApiKey": "abc123",
"numberOfPages": 987,
"title": "xyz789",
"type": "xyz789"
}
]
}
}
getChatIdByUserIds
getDbSchemaLabels
Response
Returns
[SchemaField]
Arguments
| Name | Description |
|---|---|
type -
String
|
Example
Query
query GetDbSchemaLabels($type: String) {
getDbSchemaLabels(type: $type) {
label
name
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"getDbSchemaLabels": [
{
"label": "abc123",
"name": "xyz789"
}
]
}
}
getNeighbor
Example
Query
query GetNeighbor($productCategoryId: String!) {
getNeighbor(productCategoryId: $productCategoryId) {
_id
data
info
productCategoryId
rate
}
}
Variables
{"productCategoryId": "xyz789"}
Response
{
"data": {
"getNeighbor": {
"_id": "abc123",
"data": {},
"info": {},
"productCategoryId": "abc123",
"rate": {}
}
}
}
getNeighborItem
getNeighborItems
getSystemFieldsGroup
Response
Returns a
FieldsGroup
Arguments
| Name | Description |
|---|---|
contentType -
String
|
Example
Query
query GetSystemFieldsGroup($contentType: String) {
getSystemFieldsGroup(contentType: $contentType) {
_id
code
config
contentType
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
isDefinedByErxes
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
name
order
}
}
Variables
{"contentType": "abc123"}
Response
{
"data": {
"getSystemFieldsGroup": {
"_id": "xyz789",
"code": "xyz789",
"config": {},
"contentType": "abc123",
"description": "abc123",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": false,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"name": "abc123",
"order": 123
}
}
}
getUnreadChatCount
Response
Returns an
Int
Example
Query
query GetUnreadChatCount {
getUnreadChatCount
}
Response
{"data": {"getUnreadChatCount": 987}}
growthHackDetail
Response
Returns a
GrowthHack
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query GrowthHackDetail($_id: String!) {
growthHackDetail(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"growthHackDetail": {
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 987,
"formFields": [Field],
"formId": "abc123",
"formSubmissions": {},
"hackStages": ["xyz789"],
"hasNotified": false,
"impact": 123,
"isComplete": true,
"isVoted": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "abc123",
"reach": 987,
"reminderMinute": 987,
"score": 987.65,
"scoringType": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 987,
"votedUsers": [User]
}
}
}
growthHacks
Response
Returns
[GrowthHack]
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
hackStage -
[String]
|
|
initialStageId -
String
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
search -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
stageId -
String
|
|
userIds -
[String]
|
Example
Query
query GrowthHacks(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$hackStage: [String],
$initialStageId: String,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$search: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$stageId: String,
$userIds: [String]
) {
growthHacks(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
hackStage: $hackStage,
initialStageId: $initialStageId,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
search: $search,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
stageId: $stageId,
userIds: $userIds
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_ids": ["abc123"],
"assignedToMe": "xyz789",
"assignedUserIds": ["xyz789"],
"closeDateType": "xyz789",
"hackStage": ["abc123"],
"initialStageId": "abc123",
"labelIds": ["abc123"],
"limit": 987,
"pipelineId": "abc123",
"priority": ["abc123"],
"search": "xyz789",
"skip": 123,
"sortDirection": 123,
"sortField": "abc123",
"stageId": "xyz789",
"userIds": ["xyz789"]
}
Response
{
"data": {
"growthHacks": [
{
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 123,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"ease": 123,
"formFields": [Field],
"formId": "xyz789",
"formSubmissions": {},
"hackStages": ["abc123"],
"hasNotified": false,
"impact": 123,
"isComplete": true,
"isVoted": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reach": 123,
"reminderMinute": 987,
"score": 987.65,
"scoringType": "xyz789",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789",
"voteCount": 987,
"votedUsers": [User]
}
]
}
}
growthHacksPriorityMatrix
Response
Returns a
JSON
Example
Query
query GrowthHacksPriorityMatrix(
$assignedUserIds: [String],
$closeDateType: String,
$pipelineId: String,
$search: String
) {
growthHacksPriorityMatrix(
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
pipelineId: $pipelineId,
search: $search
)
}
Variables
{
"assignedUserIds": ["abc123"],
"closeDateType": "abc123",
"pipelineId": "abc123",
"search": "xyz789"
}
Response
{"data": {"growthHacksPriorityMatrix": {}}}
growthHacksTotalCount
Response
Returns an
Int
Example
Query
query GrowthHacksTotalCount(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$hackStage: [String],
$initialStageId: String,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$search: String,
$skip: Int,
$stageId: String,
$userIds: [String]
) {
growthHacksTotalCount(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
hackStage: $hackStage,
initialStageId: $initialStageId,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
search: $search,
skip: $skip,
stageId: $stageId,
userIds: $userIds
)
}
Variables
{
"_ids": ["abc123"],
"assignedToMe": "abc123",
"assignedUserIds": ["abc123"],
"closeDateType": "xyz789",
"hackStage": ["xyz789"],
"initialStageId": "xyz789",
"labelIds": ["abc123"],
"limit": 123,
"pipelineId": "abc123",
"priority": ["abc123"],
"search": "xyz789",
"skip": 987,
"stageId": "abc123",
"userIds": ["abc123"]
}
Response
{"data": {"growthHacksTotalCount": 123}}
importHistories
Response
Returns an
ImportHistoryList
Example
Query
query ImportHistories(
$page: Int,
$perPage: Int,
$type: String
) {
importHistories(
page: $page,
perPage: $perPage,
type: $type
) {
count
list {
_id
attachments
contentTypes
date
error
errorMsgs
failed
ids
name
percentage
removed
status
success
total
updated
user
}
}
}
Variables
{
"page": 987,
"perPage": 987,
"type": "xyz789"
}
Response
{
"data": {
"importHistories": {
"count": 123,
"list": [ImportHistory]
}
}
}
importHistoryDetail
Response
Returns an
ImportHistory
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query ImportHistoryDetail($_id: String!) {
importHistoryDetail(_id: $_id) {
_id
attachments
contentTypes
date
error
errorMsgs
failed
ids
name
percentage
removed
status
success
total
updated
user
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"importHistoryDetail": {
"_id": "xyz789",
"attachments": {},
"contentTypes": {},
"date": "2007-12-03",
"error": "abc123",
"errorMsgs": ["abc123"],
"failed": "abc123",
"ids": ["xyz789"],
"name": "abc123",
"percentage": 123.45,
"removed": ["xyz789"],
"status": "abc123",
"success": "abc123",
"total": "abc123",
"updated": "xyz789",
"user": {}
}
}
}
importHistoryGetColumns
importHistoryGetDuplicatedHeaders
Example
Query
query ImportHistoryGetDuplicatedHeaders($attachmentNames: [String]) {
importHistoryGetDuplicatedHeaders(attachmentNames: $attachmentNames)
}
Variables
{"attachmentNames": ["abc123"]}
Response
{"data": {"importHistoryGetDuplicatedHeaders": {}}}
importHistoryGetExportableServices
Response
Returns a
JSON
Example
Query
query ImportHistoryGetExportableServices {
importHistoryGetExportableServices
}
Response
{"data": {"importHistoryGetExportableServices": {}}}
importHistoryGetTypes
Response
Returns a
JSON
Example
Query
query ImportHistoryGetTypes {
importHistoryGetTypes
}
Response
{"data": {"importHistoryGetTypes": {}}}
importHistoryPreviewExportCount
Example
Query
query ImportHistoryPreviewExportCount(
$contentType: String!,
$segmentId: String
) {
importHistoryPreviewExportCount(
contentType: $contentType,
segmentId: $segmentId
)
}
Variables
{
"contentType": "xyz789",
"segmentId": "abc123"
}
Response
{
"data": {
"importHistoryPreviewExportCount": "abc123"
}
}
inboxFields
Response
Returns an
InboxField
Example
Query
query InboxFields {
inboxFields {
conversation {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
customer {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
device {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
}
}
Response
{
"data": {
"inboxFields": {
"conversation": [Field],
"customer": [Field],
"device": [Field]
}
}
}
integrationDetail
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query IntegrationDetail($_id: String!) {
integrationDetail(_id: $_id) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"integrationDetail": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationGetLineWebhookUrl
integrations
Response
Returns
[Integration]
Example
Query
query Integrations(
$brandId: String,
$channelId: String,
$formLoadType: String,
$kind: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String,
$tag: String
) {
integrations(
brandId: $brandId,
channelId: $channelId,
formLoadType: $formLoadType,
kind: $kind,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status,
tag: $tag
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"brandId": "xyz789",
"channelId": "xyz789",
"formLoadType": "abc123",
"kind": "xyz789",
"page": 123,
"perPage": 987,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "abc123",
"status": "abc123",
"tag": "xyz789"
}
Response
{
"data": {
"integrations": [
{
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": true,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
]
}
}
integrationsConversationFbComments
Response
Returns
[FacebookComment]
Example
Query
query IntegrationsConversationFbComments(
$commentId: String,
$isResolved: Boolean,
$limit: Int,
$postId: String!,
$senderId: String,
$skip: Int
) {
integrationsConversationFbComments(
commentId: $commentId,
isResolved: $isResolved,
limit: $limit,
postId: $postId,
senderId: $senderId,
skip: $skip
) {
attachments
commentCount
commentId
content
conversationId
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
erxesApiId
isResolved
parentId
permalink_url
postId
recipientId
senderId
timestamp
}
}
Variables
{
"commentId": "xyz789",
"isResolved": true,
"limit": 987,
"postId": "abc123",
"senderId": "abc123",
"skip": 987
}
Response
{
"data": {
"integrationsConversationFbComments": [
{
"attachments": ["abc123"],
"commentCount": 123,
"commentId": "xyz789",
"content": "xyz789",
"conversationId": "abc123",
"customer": Customer,
"erxesApiId": "xyz789",
"isResolved": false,
"parentId": "abc123",
"permalink_url": "abc123",
"postId": "xyz789",
"recipientId": "xyz789",
"senderId": "abc123",
"timestamp": "2007-12-03"
}
]
}
}
integrationsConversationFbCommentsCount
Example
Query
query IntegrationsConversationFbCommentsCount(
$isResolved: Boolean,
$postId: String!
) {
integrationsConversationFbCommentsCount(
isResolved: $isResolved,
postId: $postId
)
}
Variables
{"isResolved": false, "postId": "xyz789"}
Response
{"data": {"integrationsConversationFbCommentsCount": {}}}
integrationsGetAccounts
integrationsGetConfigs
Response
Returns a
JSON
Example
Query
query IntegrationsGetConfigs {
integrationsGetConfigs
}
Response
{"data": {"integrationsGetConfigs": {}}}
integrationsGetFbPages
Example
Query
query IntegrationsGetFbPages(
$accountId: String!,
$kind: String!
) {
integrationsGetFbPages(
accountId: $accountId,
kind: $kind
)
}
Variables
{
"accountId": "abc123",
"kind": "xyz789"
}
Response
{"data": {"integrationsGetFbPages": {}}}
integrationsGetIntegrationDetail
Example
Query
query IntegrationsGetIntegrationDetail($erxesApiId: String) {
integrationsGetIntegrationDetail(erxesApiId: $erxesApiId)
}
Variables
{"erxesApiId": "abc123"}
Response
{"data": {"integrationsGetIntegrationDetail": {}}}
integrationsGetIntegrations
integrationsGetUsedTypes
Response
Returns
[integrationsGetUsedTypes]
Example
Query
query IntegrationsGetUsedTypes {
integrationsGetUsedTypes {
_id
name
}
}
Response
{
"data": {
"integrationsGetUsedTypes": [
{
"_id": "abc123",
"name": "abc123"
}
]
}
}
integrationsTotalCount
Response
Returns an
integrationsTotalCount
Example
Query
query IntegrationsTotalCount(
$brandId: String,
$channelId: String,
$formLoadType: String,
$kind: String,
$status: String,
$tag: String
) {
integrationsTotalCount(
brandId: $brandId,
channelId: $channelId,
formLoadType: $formLoadType,
kind: $kind,
status: $status,
tag: $tag
) {
byBrand
byChannel
byKind
byStatus
byTag
total
}
}
Variables
{
"brandId": "xyz789",
"channelId": "xyz789",
"formLoadType": "abc123",
"kind": "abc123",
"status": "xyz789",
"tag": "xyz789"
}
Response
{
"data": {
"integrationsTotalCount": {
"byBrand": {},
"byChannel": {},
"byKind": {},
"byStatus": {},
"byTag": {},
"total": 987
}
}
}
internalNoteDetail
Response
Returns an
InternalNote
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query InternalNoteDetail($_id: String!) {
internalNoteDetail(_id: $_id) {
_id
content
contentType
contentTypeId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"internalNoteDetail": {
"_id": "xyz789",
"content": "xyz789",
"contentType": "abc123",
"contentTypeId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123"
}
}
}
internalNotes
Response
Returns
[InternalNote]
Example
Query
query InternalNotes(
$contentType: String!,
$contentTypeId: String
) {
internalNotes(
contentType: $contentType,
contentTypeId: $contentTypeId
) {
_id
content
contentType
contentTypeId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
}
}
Variables
{
"contentType": "xyz789",
"contentTypeId": "abc123"
}
Response
{
"data": {
"internalNotes": [
{
"_id": "abc123",
"content": "xyz789",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123"
}
]
}
}
internalNotesAsLogs
internalNotesByAction
Response
Returns an
InternalNotesByAction
Example
Query
query InternalNotesByAction(
$contentType: String,
$page: Int,
$perPage: Int,
$pipelineId: String
) {
internalNotesByAction(
contentType: $contentType,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId
) {
list {
_id
action
content
contentId
contentType
contentTypeDetail
createdAt
createdBy
}
totalCount
}
}
Variables
{
"contentType": "xyz789",
"page": 987,
"perPage": 987,
"pipelineId": "xyz789"
}
Response
{
"data": {
"internalNotesByAction": {
"list": [ModifiedNote],
"totalCount": 123
}
}
}
itemsCountByAssignedUser
Response
Returns a
JSON
Example
Query
query ItemsCountByAssignedUser(
$pipelineId: String!,
$stackBy: String,
$type: String!
) {
itemsCountByAssignedUser(
pipelineId: $pipelineId,
stackBy: $stackBy,
type: $type
)
}
Variables
{
"pipelineId": "xyz789",
"stackBy": "xyz789",
"type": "abc123"
}
Response
{"data": {"itemsCountByAssignedUser": {}}}
itemsCountBySegments
Response
Returns a
JSON
Example
Query
query ItemsCountBySegments(
$boardId: String,
$pipelineId: String,
$type: String!
) {
itemsCountBySegments(
boardId: $boardId,
pipelineId: $pipelineId,
type: $type
)
}
Variables
{
"boardId": "abc123",
"pipelineId": "xyz789",
"type": "xyz789"
}
Response
{"data": {"itemsCountBySegments": {}}}
knowledgeBaseArticleDetail
Response
Returns a
KnowledgeBaseArticle
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query KnowledgeBaseArticleDetail($_id: String!) {
knowledgeBaseArticleDetail(_id: $_id) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"knowledgeBaseArticleDetail": {
"_id": "abc123",
"attachments": [Attachment],
"categoryId": "abc123",
"content": "xyz789",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"reactionChoices": ["xyz789"],
"reactionCounts": {},
"status": "abc123",
"summary": "xyz789",
"title": "abc123",
"topicId": "abc123",
"viewCount": 987
}
}
}
knowledgeBaseArticleDetailAndIncViewCount
Response
Returns a
KnowledgeBaseArticle
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query KnowledgeBaseArticleDetailAndIncViewCount($_id: String!) {
knowledgeBaseArticleDetailAndIncViewCount(_id: $_id) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"knowledgeBaseArticleDetailAndIncViewCount": {
"_id": "abc123",
"attachments": [Attachment],
"categoryId": "xyz789",
"content": "abc123",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"reactionChoices": ["xyz789"],
"reactionCounts": {},
"status": "xyz789",
"summary": "xyz789",
"title": "abc123",
"topicId": "xyz789",
"viewCount": 123
}
}
}
knowledgeBaseArticles
Response
Returns
[KnowledgeBaseArticle]
Example
Query
query KnowledgeBaseArticles(
$categoryIds: [String],
$page: Int,
$perPage: Int,
$searchValue: String
) {
knowledgeBaseArticles(
categoryIds: $categoryIds,
page: $page,
perPage: $perPage,
searchValue: $searchValue
) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{
"categoryIds": ["abc123"],
"page": 123,
"perPage": 987,
"searchValue": "abc123"
}
Response
{
"data": {
"knowledgeBaseArticles": [
{
"_id": "abc123",
"attachments": [Attachment],
"categoryId": "xyz789",
"content": "xyz789",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"reactionChoices": ["xyz789"],
"reactionCounts": {},
"status": "xyz789",
"summary": "abc123",
"title": "xyz789",
"topicId": "xyz789",
"viewCount": 987
}
]
}
}
knowledgeBaseArticlesTotalCount
Example
Query
query KnowledgeBaseArticlesTotalCount($categoryIds: [String]) {
knowledgeBaseArticlesTotalCount(categoryIds: $categoryIds)
}
Variables
{"categoryIds": ["abc123"]}
Response
{"data": {"knowledgeBaseArticlesTotalCount": 123}}
knowledgeBaseCategories
Response
Returns
[KnowledgeBaseCategory]
Example
Query
query KnowledgeBaseCategories(
$page: Int,
$perPage: Int,
$topicIds: [String]
) {
knowledgeBaseCategories(
page: $page,
perPage: $perPage,
topicIds: $topicIds
) {
_id
articles {
_id
attachments {
...AttachmentFragment
}
categoryId
content
createdBy
createdDate
createdUser {
...UserFragment
}
image {
...AttachmentFragment
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
authors {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdBy
createdDate
description
firstTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
}
Variables
{
"page": 987,
"perPage": 123,
"topicIds": ["xyz789"]
}
Response
{
"data": {
"knowledgeBaseCategories": [
{
"_id": "xyz789",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "xyz789",
"firstTopic": KnowledgeBaseTopic,
"icon": "xyz789",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"numOfArticles": 987.65,
"parentCategoryId": "abc123",
"title": "abc123"
}
]
}
}
knowledgeBaseCategoriesGetLast
Response
Returns a
KnowledgeBaseCategory
Example
Query
query KnowledgeBaseCategoriesGetLast {
knowledgeBaseCategoriesGetLast {
_id
articles {
_id
attachments {
...AttachmentFragment
}
categoryId
content
createdBy
createdDate
createdUser {
...UserFragment
}
image {
...AttachmentFragment
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
authors {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdBy
createdDate
description
firstTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
}
Response
{
"data": {
"knowledgeBaseCategoriesGetLast": {
"_id": "abc123",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "abc123",
"firstTopic": KnowledgeBaseTopic,
"icon": "abc123",
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"numOfArticles": 987.65,
"parentCategoryId": "xyz789",
"title": "abc123"
}
}
}
knowledgeBaseCategoriesTotalCount
Example
Query
query KnowledgeBaseCategoriesTotalCount($topicIds: [String]) {
knowledgeBaseCategoriesTotalCount(topicIds: $topicIds)
}
Variables
{"topicIds": ["xyz789"]}
Response
{"data": {"knowledgeBaseCategoriesTotalCount": 123}}
knowledgeBaseCategoryDetail
Response
Returns a
KnowledgeBaseCategory
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query KnowledgeBaseCategoryDetail($_id: String!) {
knowledgeBaseCategoryDetail(_id: $_id) {
_id
articles {
_id
attachments {
...AttachmentFragment
}
categoryId
content
createdBy
createdDate
createdUser {
...UserFragment
}
image {
...AttachmentFragment
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
authors {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdBy
createdDate
description
firstTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"knowledgeBaseCategoryDetail": {
"_id": "abc123",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"description": "xyz789",
"firstTopic": KnowledgeBaseTopic,
"icon": "abc123",
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"numOfArticles": 987.65,
"parentCategoryId": "abc123",
"title": "abc123"
}
}
}
knowledgeBaseTopicDetail
Response
Returns a
KnowledgeBaseTopic
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query KnowledgeBaseTopicDetail($_id: String!) {
knowledgeBaseTopicDetail(_id: $_id) {
_id
backgroundImage
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
categories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
childrens {
...KnowledgeBaseCategoryFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
title
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"knowledgeBaseTopicDetail": {
"_id": "xyz789",
"backgroundImage": "abc123",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "abc123",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"description": "abc123",
"languageCode": "xyz789",
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "xyz789"
}
}
}
knowledgeBaseTopics
Response
Returns
[KnowledgeBaseTopic]
Example
Query
query KnowledgeBaseTopics(
$brandId: String,
$page: Int,
$perPage: Int
) {
knowledgeBaseTopics(
brandId: $brandId,
page: $page,
perPage: $perPage
) {
_id
backgroundImage
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
categories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
childrens {
...KnowledgeBaseCategoryFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
title
}
}
Variables
{
"brandId": "xyz789",
"page": 987,
"perPage": 987
}
Response
{
"data": {
"knowledgeBaseTopics": [
{
"_id": "abc123",
"backgroundImage": "xyz789",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "abc123",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"description": "xyz789",
"languageCode": "xyz789",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "abc123"
}
]
}
}
knowledgeBaseTopicsTotalCount
Response
Returns an
Int
Example
Query
query KnowledgeBaseTopicsTotalCount {
knowledgeBaseTopicsTotalCount
}
Response
{"data": {"knowledgeBaseTopicsTotalCount": 987}}
logs
Response
Returns a
LogList
Example
Query
query Logs(
$action: String,
$end: String,
$page: Int,
$perPage: Int,
$start: String,
$type: String,
$userId: String
) {
logs(
action: $action,
end: $end,
page: $page,
perPage: $perPage,
start: $start,
type: $type,
userId: $userId
) {
logs {
_id
action
addedData
changedData
createdAt
createdBy
description
extraDesc
newData
objectId
oldData
removedData
type
unchangedData
unicode
}
totalCount
}
}
Variables
{
"action": "abc123",
"end": "xyz789",
"page": 987,
"perPage": 987,
"start": "xyz789",
"type": "abc123",
"userId": "xyz789"
}
Response
{"data": {"logs": {"logs": [Log], "totalCount": 123}}}
lotteries
Response
Returns
[Lottery]
Example
Query
query Lotteries(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String,
$voucherCampaignId: String
) {
lotteries(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status,
voucherCampaignId: $voucherCampaignId
) {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "xyz789",
"ownerType": "abc123",
"page": 123,
"perPage": 123,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "abc123",
"status": "xyz789",
"voucherCampaignId": "abc123"
}
Response
{
"data": {
"lotteries": [
{
"_id": "xyz789",
"awardId": "xyz789",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"number": "xyz789",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
]
}
}
lotteriesMain
Response
Returns a
LotteryMain
Example
Query
query LotteriesMain(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String,
$voucherCampaignId: String
) {
lotteriesMain(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status,
voucherCampaignId: $voucherCampaignId
) {
list {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
totalCount
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "abc123",
"ownerType": "xyz789",
"page": 123,
"perPage": 987,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "abc123",
"status": "abc123",
"voucherCampaignId": "xyz789"
}
Response
{
"data": {
"lotteriesMain": {
"list": [Lottery],
"totalCount": 123
}
}
}
lotteryCampaignDetail
Response
Returns a
LotteryCampaign
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query LotteryCampaignDetail($_id: String!) {
lotteryCampaignDetail(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
lotteriesCount
modifiedAt
modifiedBy
numberFormat
startDate
status
title
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"lotteryCampaignDetail": {
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteriesCount": 987,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"numberFormat": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"title": "abc123"
}
}
}
lotteryCampaigns
Response
Returns
[LotteryCampaign]
Example
Query
query LotteryCampaigns(
$filterStatus: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String
) {
lotteryCampaigns(
filterStatus: $filterStatus,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField
) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
lotteriesCount
modifiedAt
modifiedBy
numberFormat
startDate
status
title
}
}
Variables
{
"filterStatus": "abc123",
"page": 123,
"perPage": 123,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "xyz789"
}
Response
{
"data": {
"lotteryCampaigns": [
{
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"buyScore": 123.45,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteriesCount": 123,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"numberFormat": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
]
}
}
lotteryCampaignsCount
Example
Query
query LotteryCampaignsCount(
$filterStatus: String,
$searchValue: String
) {
lotteryCampaignsCount(
filterStatus: $filterStatus,
searchValue: $searchValue
)
}
Variables
{
"filterStatus": "xyz789",
"searchValue": "abc123"
}
Response
{"data": {"lotteryCampaignsCount": 123}}
lotteryDetail
Example
Query
query LotteryDetail($_id: String!) {
lotteryDetail(_id: $_id) {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"lotteryDetail": {
"_id": "abc123",
"awardId": "abc123",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"number": "xyz789",
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
}
}
loyalties
Response
Returns a
Loyalty
Example
Query
query Loyalties(
$ownerId: String,
$ownerType: String,
$statuses: [String]
) {
loyalties(
ownerId: $ownerId,
ownerType: $ownerType,
statuses: $statuses
) {
donates {
_id
awardId
campaign
campaignId
createdAt
donateScore
owner
ownerId
ownerType
usedAt
voucherCampaignId
voucherId
}
lotteries {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
ownerId
ownerType
score
spins {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
vouchers {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
}
}
Variables
{
"ownerId": "abc123",
"ownerType": "xyz789",
"statuses": ["abc123"]
}
Response
{
"data": {
"loyalties": {
"donates": [Donate],
"lotteries": [Lottery],
"ownerId": "xyz789",
"ownerType": "xyz789",
"score": 123.45,
"spins": [Spin],
"vouchers": [Voucher]
}
}
}
loyaltyConfigs
Response
Returns
[LoyaltyConfig]
Example
Query
query LoyaltyConfigs {
loyaltyConfigs {
_id
code
value
}
}
Response
{
"data": {
"loyaltyConfigs": [
{
"_id": "xyz789",
"code": "abc123",
"value": {}
}
]
}
}
messengerApps
Response
Returns a
MessengerAppsResponse
Arguments
| Name | Description |
|---|---|
integrationId -
String!
|
Example
Query
query MessengerApps($integrationId: String!) {
messengerApps(integrationId: $integrationId) {
knowledgebases {
topicId
}
leads {
formCode
}
websites {
buttonText
description
url
}
}
}
Variables
{"integrationId": "abc123"}
Response
{
"data": {
"messengerApps": {
"knowledgebases": [KnowledgebaseApp],
"leads": [LeadApp],
"websites": [WebSiteApp]
}
}
}
noDepartmentUsers
Example
Query
query NoDepartmentUsers($excludeId: String) {
noDepartmentUsers(excludeId: $excludeId) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"excludeId": "xyz789"}
Response
{
"data": {
"noDepartmentUsers": [
{
"_id": "abc123",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["xyz789"],
"isActive": false,
"isOwner": false,
"isShowNotification": false,
"isSubscribed": "xyz789",
"leaderBoardPosition": 987,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "abc123",
"username": "abc123"
}
]
}
}
notificationCounts
Example
Query
query NotificationCounts(
$notifType: String,
$requireRead: Boolean
) {
notificationCounts(
notifType: $notifType,
requireRead: $requireRead
)
}
Variables
{"notifType": "xyz789", "requireRead": true}
Response
{"data": {"notificationCounts": 123}}
notifications
Response
Returns
[Notification]
Example
Query
query Notifications(
$endDate: String,
$limit: Int,
$notifType: String,
$page: Int,
$perPage: Int,
$requireRead: Boolean,
$startDate: String,
$title: String
) {
notifications(
endDate: $endDate,
limit: $limit,
notifType: $notifType,
page: $page,
perPage: $perPage,
requireRead: $requireRead,
startDate: $startDate,
title: $title
) {
_id
action
content
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
date
isRead
link
notifType
receiver
title
}
}
Variables
{
"endDate": "abc123",
"limit": 987,
"notifType": "abc123",
"page": 123,
"perPage": 987,
"requireRead": false,
"startDate": "xyz789",
"title": "xyz789"
}
Response
{
"data": {
"notifications": [
{
"_id": "xyz789",
"action": "xyz789",
"content": "abc123",
"createdUser": User,
"date": "2007-12-03",
"isRead": true,
"link": "xyz789",
"notifType": "abc123",
"receiver": "abc123",
"title": "abc123"
}
]
}
}
notificationsGetConfigurations
Response
Returns
[NotificationConfiguration]
Example
Query
query NotificationsGetConfigurations {
notificationsGetConfigurations {
_id
isAllowed
notifType
user
}
}
Response
{
"data": {
"notificationsGetConfigurations": [
{
"_id": "abc123",
"isAllowed": true,
"notifType": "xyz789",
"user": "abc123"
}
]
}
}
notificationsModules
Response
Returns
[JSON]
Example
Query
query NotificationsModules {
notificationsModules
}
Response
{"data": {"notificationsModules": [{}]}}
onboardingGetAvailableFeatures
Response
Example
Query
query OnboardingGetAvailableFeatures {
onboardingGetAvailableFeatures {
isComplete
name
settings
showSettings
}
}
Response
{
"data": {
"onboardingGetAvailableFeatures": [
{
"isComplete": true,
"name": "xyz789",
"settings": ["abc123"],
"showSettings": true
}
]
}
}
onboardingStepsCompleteness
permissionActions
Response
Returns
[PermissionAction]
Example
Query
query PermissionActions {
permissionActions {
description
module
name
}
}
Response
{
"data": {
"permissionActions": [
{
"description": "xyz789",
"module": "abc123",
"name": "xyz789"
}
]
}
}
permissionModules
Response
Returns
[PermissionModule]
Example
Query
query PermissionModules {
permissionModules {
description
name
}
}
Response
{
"data": {
"permissionModules": [
{
"description": "xyz789",
"name": "xyz789"
}
]
}
}
permissions
Response
Returns
[Permission]
Example
Query
query Permissions(
$action: String,
$allowed: Boolean,
$groupId: String,
$module: String,
$page: Int,
$perPage: Int,
$userId: String
) {
permissions(
action: $action,
allowed: $allowed,
groupId: $groupId,
module: $module,
page: $page,
perPage: $perPage,
userId: $userId
) {
_id
action
allowed
group {
_id
description
memberIds
members {
...UserFragment
}
name
}
groupId
module
requiredActions
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
}
}
Variables
{
"action": "abc123",
"allowed": true,
"groupId": "abc123",
"module": "abc123",
"page": 987,
"perPage": 123,
"userId": "abc123"
}
Response
{
"data": {
"permissions": [
{
"_id": "xyz789",
"action": "xyz789",
"allowed": true,
"group": UsersGroup,
"groupId": "xyz789",
"module": "xyz789",
"requiredActions": ["xyz789"],
"user": User,
"userId": "xyz789"
}
]
}
}
permissionsTotalCount
Response
Returns an
Int
Example
Query
query PermissionsTotalCount(
$action: String,
$allowed: Boolean,
$groupId: String,
$module: String,
$userId: String
) {
permissionsTotalCount(
action: $action,
allowed: $allowed,
groupId: $groupId,
module: $module,
userId: $userId
)
}
Variables
{
"action": "abc123",
"allowed": true,
"groupId": "abc123",
"module": "abc123",
"userId": "xyz789"
}
Response
{"data": {"permissionsTotalCount": 987}}
pipelineAssignedUsers
Example
Query
query PipelineAssignedUsers($_id: String!) {
pipelineAssignedUsers(_id: $_id) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"pipelineAssignedUsers": [
{
"_id": "abc123",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["xyz789"],
"isActive": false,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 987,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "xyz789",
"username": "abc123"
}
]
}
}
pipelineDetail
Example
Query
query PipelineDetail($_id: String!) {
pipelineDetail(_id: $_id) {
_id
bgColor
boardId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"pipelineDetail": {
"_id": "xyz789",
"bgColor": "abc123",
"boardId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["abc123"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["abc123"],
"hackScoringType": "xyz789",
"isCheckDepartment": true,
"isCheckUser": true,
"isWatched": true,
"itemsTotalCount": 123,
"memberIds": ["abc123"],
"members": [User],
"metric": "abc123",
"name": "xyz789",
"numberConfig": "xyz789",
"numberSize": "abc123",
"order": 123,
"startDate": "2007-12-03",
"state": "xyz789",
"status": "xyz789",
"templateId": "abc123",
"type": "abc123",
"userId": "abc123",
"visibility": "abc123"
}
}
}
pipelineLabelDetail
Response
Returns a
PipelineLabel
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query PipelineLabelDetail($_id: String!) {
pipelineLabelDetail(_id: $_id) {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"pipelineLabelDetail": {
"_id": "abc123",
"colorCode": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"name": "abc123",
"pipelineId": "xyz789"
}
}
}
pipelineLabels
Response
Returns
[PipelineLabel]
Arguments
| Name | Description |
|---|---|
pipelineId -
String!
|
Example
Query
query PipelineLabels($pipelineId: String!) {
pipelineLabels(pipelineId: $pipelineId) {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
}
Variables
{"pipelineId": "abc123"}
Response
{
"data": {
"pipelineLabels": [
{
"_id": "abc123",
"colorCode": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"name": "xyz789",
"pipelineId": "abc123"
}
]
}
}
pipelineStateCount
Example
Query
query PipelineStateCount(
$boardId: String,
$type: String
) {
pipelineStateCount(
boardId: $boardId,
type: $type
)
}
Variables
{
"boardId": "xyz789",
"type": "xyz789"
}
Response
{"data": {"pipelineStateCount": {}}}
pipelineTemplateDetail
Response
Returns a
PipelineTemplate
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query PipelineTemplateDetail($_id: String!) {
pipelineTemplateDetail(_id: $_id) {
_id
createdAt
createdBy
description
isDefinedByErxes
name
stages {
_id
formId
name
order
}
type
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"pipelineTemplateDetail": {
"_id": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"isDefinedByErxes": true,
"name": "xyz789",
"stages": [PipelineTemplateStage],
"type": "xyz789"
}
}
}
pipelineTemplates
Response
Returns
[PipelineTemplate]
Arguments
| Name | Description |
|---|---|
type -
String!
|
Example
Query
query PipelineTemplates($type: String!) {
pipelineTemplates(type: $type) {
_id
createdAt
createdBy
description
isDefinedByErxes
name
stages {
_id
formId
name
order
}
type
}
}
Variables
{"type": "abc123"}
Response
{
"data": {
"pipelineTemplates": [
{
"_id": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"isDefinedByErxes": true,
"name": "xyz789",
"stages": [PipelineTemplateStage],
"type": "xyz789"
}
]
}
}
pipelineTemplatesTotalCount
Response
Returns an
Int
Example
Query
query PipelineTemplatesTotalCount {
pipelineTemplatesTotalCount
}
Response
{"data": {"pipelineTemplatesTotalCount": 123}}
pipelines
Response
Returns
[Pipeline]
Example
Query
query Pipelines(
$boardId: String,
$isAll: Boolean,
$page: Int,
$perPage: Int,
$type: String
) {
pipelines(
boardId: $boardId,
isAll: $isAll,
page: $page,
perPage: $perPage,
type: $type
) {
_id
bgColor
boardId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
}
Variables
{
"boardId": "abc123",
"isAll": true,
"page": 987,
"perPage": 987,
"type": "xyz789"
}
Response
{
"data": {
"pipelines": [
{
"_id": "xyz789",
"bgColor": "abc123",
"boardId": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["abc123"],
"hackScoringType": "abc123",
"isCheckDepartment": true,
"isCheckUser": true,
"isWatched": true,
"itemsTotalCount": 987,
"memberIds": ["xyz789"],
"members": [User],
"metric": "xyz789",
"name": "abc123",
"numberConfig": "xyz789",
"numberSize": "xyz789",
"order": 987,
"startDate": "2007-12-03",
"state": "xyz789",
"status": "abc123",
"templateId": "xyz789",
"type": "abc123",
"userId": "xyz789",
"visibility": "abc123"
}
]
}
}
productCategories
Response
Returns
[ProductCategory]
Example
Query
query ProductCategories(
$parentId: String,
$searchValue: String,
$status: String
) {
productCategories(
parentId: $parentId,
searchValue: $searchValue,
status: $status
) {
_id
attachment {
duration
name
size
type
url
}
code
description
isRoot
name
order
parentId
productCount
status
}
}
Variables
{
"parentId": "abc123",
"searchValue": "xyz789",
"status": "xyz789"
}
Response
{
"data": {
"productCategories": [
{
"_id": "abc123",
"attachment": Attachment,
"code": "xyz789",
"description": "xyz789",
"isRoot": false,
"name": "abc123",
"order": "abc123",
"parentId": "xyz789",
"productCount": 987,
"status": "xyz789"
}
]
}
}
productCategoriesTotalCount
Response
Returns an
Int
Example
Query
query ProductCategoriesTotalCount {
productCategoriesTotalCount
}
Response
{"data": {"productCategoriesTotalCount": 123}}
productCategoryDetail
Response
Returns a
ProductCategory
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
query ProductCategoryDetail($_id: String) {
productCategoryDetail(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
code
description
isRoot
name
order
parentId
productCount
status
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"productCategoryDetail": {
"_id": "xyz789",
"attachment": Attachment,
"code": "xyz789",
"description": "xyz789",
"isRoot": false,
"name": "abc123",
"order": "abc123",
"parentId": "abc123",
"productCount": 123,
"status": "abc123"
}
}
}
productCountByTags
Response
Returns a
JSON
Example
Query
query ProductCountByTags {
productCountByTags
}
Response
{"data": {"productCountByTags": {}}}
productDetail
Example
Query
query ProductDetail($_id: String) {
productDetail(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
attachmentMore {
duration
name
size
type
url
}
category {
_id
attachment {
...AttachmentFragment
}
code
description
isRoot
name
order
parentId
productCount
status
}
categoryId
code
createdAt
customFieldsData
description
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
vendorId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"productDetail": {
"_id": "xyz789",
"attachment": Attachment,
"attachmentMore": [Attachment],
"category": ProductCategory,
"categoryId": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"getTags": [Tag],
"minimiumCount": 987,
"name": "abc123",
"productCount": 987,
"sku": "xyz789",
"supply": "abc123",
"tagIds": ["xyz789"],
"type": "xyz789",
"unitPrice": 987.65,
"vendor": Company,
"vendorId": "xyz789"
}
}
}
products
Response
Returns
[Product]
Example
Query
query Products(
$boardId: String,
$categoryId: String,
$excludeIds: Boolean,
$ids: [String],
$page: Int,
$perPage: Int,
$pipelineId: String,
$searchValue: String,
$tag: String,
$type: String
) {
products(
boardId: $boardId,
categoryId: $categoryId,
excludeIds: $excludeIds,
ids: $ids,
page: $page,
perPage: $perPage,
pipelineId: $pipelineId,
searchValue: $searchValue,
tag: $tag,
type: $type
) {
_id
attachment {
duration
name
size
type
url
}
attachmentMore {
duration
name
size
type
url
}
category {
_id
attachment {
...AttachmentFragment
}
code
description
isRoot
name
order
parentId
productCount
status
}
categoryId
code
createdAt
customFieldsData
description
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
vendorId
}
}
Variables
{
"boardId": "abc123",
"categoryId": "xyz789",
"excludeIds": true,
"ids": ["abc123"],
"page": 987,
"perPage": 123,
"pipelineId": "xyz789",
"searchValue": "abc123",
"tag": "xyz789",
"type": "xyz789"
}
Response
{
"data": {
"products": [
{
"_id": "abc123",
"attachment": Attachment,
"attachmentMore": [Attachment],
"category": ProductCategory,
"categoryId": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"getTags": [Tag],
"minimiumCount": 123,
"name": "xyz789",
"productCount": 123,
"sku": "xyz789",
"supply": "xyz789",
"tagIds": ["abc123"],
"type": "xyz789",
"unitPrice": 123.45,
"vendor": Company,
"vendorId": "abc123"
}
]
}
}
productsTotalCount
responseTemplates
Response
Returns
[ResponseTemplate]
Example
Query
query ResponseTemplates(
$brandId: String,
$page: Int,
$perPage: Int,
$searchValue: String
) {
responseTemplates(
brandId: $brandId,
page: $page,
perPage: $perPage,
searchValue: $searchValue
) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
content
files
name
}
}
Variables
{
"brandId": "abc123",
"page": 987,
"perPage": 987,
"searchValue": "abc123"
}
Response
{
"data": {
"responseTemplates": [
{
"_id": "abc123",
"brand": Brand,
"brandId": "xyz789",
"content": "abc123",
"files": {},
"name": "xyz789"
}
]
}
}
responseTemplatesTotalCount
Example
Query
query ResponseTemplatesTotalCount(
$brandId: String,
$searchValue: String
) {
responseTemplatesTotalCount(
brandId: $brandId,
searchValue: $searchValue
)
}
Variables
{
"brandId": "xyz789",
"searchValue": "abc123"
}
Response
{"data": {"responseTemplatesTotalCount": 123}}
robotEntries
Response
Returns
[RobotEntry]
Example
Query
query RobotEntries(
$action: String,
$isNotified: Boolean,
$parentId: String
) {
robotEntries(
action: $action,
isNotified: $isNotified,
parentId: $parentId
) {
_id
action
data
}
}
Variables
{
"action": "abc123",
"isNotified": true,
"parentId": "abc123"
}
Response
{
"data": {
"robotEntries": [
{
"_id": "abc123",
"action": "xyz789",
"data": {}
}
]
}
}
scoreLogs
Response
Returns
[ScoreLog]
Example
Query
query ScoreLogs(
$ownerId: String,
$ownerType: String,
$searchValue: String
) {
scoreLogs(
ownerId: $ownerId,
ownerType: $ownerType,
searchValue: $searchValue
) {
changeScore
createdAt
createdBy
description
owner
ownerId
ownerType
}
}
Variables
{
"ownerId": "xyz789",
"ownerType": "abc123",
"searchValue": "abc123"
}
Response
{
"data": {
"scoreLogs": [
{
"changeScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "xyz789",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789"
}
]
}
}
scripts
Example
Query
query Scripts(
$page: Int,
$perPage: Int
) {
scripts(
page: $page,
perPage: $perPage
) {
_id
kbTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
kbTopicId
leadIds
leads {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
messenger {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
messengerId
name
}
}
Variables
{"page": 987, "perPage": 123}
Response
{
"data": {
"scripts": [
{
"_id": "abc123",
"kbTopic": KnowledgeBaseTopic,
"kbTopicId": "xyz789",
"leadIds": ["xyz789"],
"leads": [Integration],
"messenger": Integration,
"messengerId": "abc123",
"name": "xyz789"
}
]
}
}
scriptsTotalCount
Response
Returns an
Int
Example
Query
query ScriptsTotalCount {
scriptsTotalCount
}
Response
{"data": {"scriptsTotalCount": 123}}
search
segmentDetail
Example
Query
query SegmentDetail($_id: String) {
segmentDetail(_id: $_id) {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"segmentDetail": {
"_id": "abc123",
"color": "abc123",
"conditions": {},
"conditionsConjunction": "abc123",
"config": {},
"contentType": "xyz789",
"count": 123,
"description": "abc123",
"getSubSegments": [Segment],
"name": "xyz789",
"shouldWriteActivityLog": false,
"subOf": "xyz789",
"subSegmentConditions": [Segment]
}
}
}
segments
Example
Query
query Segments(
$config: JSON,
$contentTypes: [String]!
) {
segments(
config: $config,
contentTypes: $contentTypes
) {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
}
}
Variables
{"config": {}, "contentTypes": ["xyz789"]}
Response
{
"data": {
"segments": [
{
"_id": "abc123",
"color": "xyz789",
"conditions": {},
"conditionsConjunction": "abc123",
"config": {},
"contentType": "xyz789",
"count": 987,
"description": "abc123",
"getSubSegments": [Segment],
"name": "abc123",
"shouldWriteActivityLog": true,
"subOf": "abc123",
"subSegmentConditions": [Segment]
}
]
}
}
segmentsEvents
segmentsGetAssociationTypes
segmentsGetHeads
Response
Returns
[Segment]
Example
Query
query SegmentsGetHeads {
segmentsGetHeads {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
}
}
Response
{
"data": {
"segmentsGetHeads": [
{
"_id": "abc123",
"color": "abc123",
"conditions": {},
"conditionsConjunction": "xyz789",
"config": {},
"contentType": "abc123",
"count": 987,
"description": "abc123",
"getSubSegments": [Segment],
"name": "xyz789",
"shouldWriteActivityLog": false,
"subOf": "xyz789",
"subSegmentConditions": [Segment]
}
]
}
}
segmentsGetTypes
Response
Returns
[JSON]
Example
Query
query SegmentsGetTypes {
segmentsGetTypes
}
Response
{"data": {"segmentsGetTypes": [{}]}}
segmentsPreviewCount
Response
Returns an
Int
Example
Query
query SegmentsPreviewCount(
$conditions: JSON,
$conditionsConjunction: String,
$config: JSON,
$contentType: String!,
$subOf: String
) {
segmentsPreviewCount(
conditions: $conditions,
conditionsConjunction: $conditionsConjunction,
config: $config,
contentType: $contentType,
subOf: $subOf
)
}
Variables
{
"conditions": {},
"conditionsConjunction": "abc123",
"config": {},
"contentType": "abc123",
"subOf": "xyz789"
}
Response
{"data": {"segmentsPreviewCount": 123}}
skill
Example
Query
query Skill($_id: String!) {
skill(_id: $_id) {
_id
memberIds
name
typeId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"skill": {
"_id": "xyz789",
"memberIds": ["xyz789"],
"name": "xyz789",
"typeId": "abc123"
}
}
}
skillTypes
Response
Returns
[SkillType]
Example
Query
query SkillTypes {
skillTypes {
_id
name
}
}
Response
{
"data": {
"skillTypes": [
{
"_id": "xyz789",
"name": "xyz789"
}
]
}
}
skillTypesTotalCount
Response
Returns an
Int
Example
Query
query SkillTypesTotalCount {
skillTypesTotalCount
}
Response
{"data": {"skillTypesTotalCount": 123}}
skills
Response
Returns
[Skill]
Example
Query
query Skills(
$list: Boolean,
$memberIds: [String],
$page: Int,
$perPage: Int,
$typeId: String
) {
skills(
list: $list,
memberIds: $memberIds,
page: $page,
perPage: $perPage,
typeId: $typeId
) {
_id
memberIds
name
typeId
}
}
Variables
{
"list": true,
"memberIds": ["xyz789"],
"page": 987,
"perPage": 987,
"typeId": "abc123"
}
Response
{
"data": {
"skills": [
{
"_id": "xyz789",
"memberIds": ["xyz789"],
"name": "xyz789",
"typeId": "xyz789"
}
]
}
}
skillsTotalCount
spinCampaignDetail
Response
Returns a
SpinCampaign
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query SpinCampaignDetail($_id: String!) {
spinCampaignDetail(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
modifiedAt
modifiedBy
spinsCount
startDate
status
title
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"spinCampaignDetail": {
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"spinsCount": 123,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
}
}
spinCampaigns
Response
Returns
[SpinCampaign]
Example
Query
query SpinCampaigns(
$filterStatus: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String
) {
spinCampaigns(
filterStatus: $filterStatus,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField
) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
modifiedAt
modifiedBy
spinsCount
startDate
status
title
}
}
Variables
{
"filterStatus": "abc123",
"page": 987,
"perPage": 987,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "abc123"
}
Response
{
"data": {
"spinCampaigns": [
{
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"spinsCount": 987,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
]
}
}
spinCampaignsCount
Example
Query
query SpinCampaignsCount(
$filterStatus: String,
$searchValue: String
) {
spinCampaignsCount(
filterStatus: $filterStatus,
searchValue: $searchValue
)
}
Variables
{
"filterStatus": "abc123",
"searchValue": "abc123"
}
Response
{"data": {"spinCampaignsCount": 123}}
spinDetail
Example
Query
query SpinDetail($_id: String!) {
spinDetail(_id: $_id) {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"spinDetail": {
"_id": "abc123",
"awardId": "xyz789",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
}
}
spins
Response
Returns
[Spin]
Example
Query
query Spins(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String,
$voucherCampaignId: String
) {
spins(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status,
voucherCampaignId: $voucherCampaignId
) {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "xyz789",
"ownerType": "abc123",
"page": 987,
"perPage": 123,
"searchValue": "xyz789",
"sortDirection": 123,
"sortField": "xyz789",
"status": "abc123",
"voucherCampaignId": "abc123"
}
Response
{
"data": {
"spins": [
{
"_id": "abc123",
"awardId": "abc123",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "abc123"
}
]
}
}
spinsMain
Response
Returns a
SpinMain
Example
Query
query SpinsMain(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String,
$voucherCampaignId: String
) {
spinsMain(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status,
voucherCampaignId: $voucherCampaignId
) {
list {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
totalCount
}
}
Variables
{
"campaignId": "abc123",
"ownerId": "xyz789",
"ownerType": "abc123",
"page": 987,
"perPage": 987,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "abc123",
"status": "abc123",
"voucherCampaignId": "xyz789"
}
Response
{
"data": {
"spinsMain": {"list": [Spin], "totalCount": 123}
}
}
stageDetail
Response
Returns a
Stage
Example
Query
query StageDetail(
$_id: String!,
$age: Int,
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$customerIds: [String],
$extraParams: JSON,
$labelIds: [String],
$search: String
) {
stageDetail(
_id: $_id,
age: $age,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
customerIds: $customerIds,
extraParams: $extraParams,
labelIds: $labelIds,
search: $search
) {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
}
Variables
{
"_id": "abc123",
"age": 987,
"assignedToMe": "abc123",
"assignedUserIds": ["abc123"],
"closeDateType": "xyz789",
"companyIds": ["xyz789"],
"customerIds": ["abc123"],
"extraParams": {},
"labelIds": ["abc123"],
"search": "abc123"
}
Response
{
"data": {
"stageDetail": {
"_id": "xyz789",
"age": 123,
"amount": {},
"code": "xyz789",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["abc123"],
"formId": "abc123",
"inProcessDealsTotalCount": 123,
"initialDealsTotalCount": 123,
"itemsTotalCount": 123,
"memberIds": ["xyz789"],
"members": [User],
"name": "abc123",
"order": 987,
"pipelineId": "xyz789",
"probability": "xyz789",
"status": "abc123",
"stayedDealsTotalCount": 987,
"type": "xyz789",
"visibility": "abc123"
}
}
}
stages
Response
Returns
[Stage]
Example
Query
query Stages(
$age: Int,
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$customerIds: [String],
$extraParams: JSON,
$isAll: Boolean,
$isNotLost: Boolean,
$labelIds: [String],
$pipelineId: String!,
$search: String
) {
stages(
age: $age,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
customerIds: $customerIds,
extraParams: $extraParams,
isAll: $isAll,
isNotLost: $isNotLost,
labelIds: $labelIds,
pipelineId: $pipelineId,
search: $search
) {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
}
Variables
{
"age": 123,
"assignedToMe": "abc123",
"assignedUserIds": ["abc123"],
"closeDateType": "abc123",
"companyIds": ["abc123"],
"customerIds": ["xyz789"],
"extraParams": {},
"isAll": false,
"isNotLost": true,
"labelIds": ["xyz789"],
"pipelineId": "abc123",
"search": "abc123"
}
Response
{
"data": {
"stages": [
{
"_id": "xyz789",
"age": 123,
"amount": {},
"code": "xyz789",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["xyz789"],
"formId": "xyz789",
"inProcessDealsTotalCount": 987,
"initialDealsTotalCount": 123,
"itemsTotalCount": 123,
"memberIds": ["xyz789"],
"members": [User],
"name": "xyz789",
"order": 987,
"pipelineId": "abc123",
"probability": "xyz789",
"status": "abc123",
"stayedDealsTotalCount": 987,
"type": "abc123",
"visibility": "abc123"
}
]
}
}
structureDetail
Response
Returns a
Structure
Example
Query
query StructureDetail {
structureDetail {
_id
code
coordinate {
latitude
longitude
}
description
email
image {
duration
name
size
type
url
}
links
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
}
}
Response
{
"data": {
"structureDetail": {
"_id": "abc123",
"code": "abc123",
"coordinate": Coordinate,
"description": "xyz789",
"email": "abc123",
"image": Attachment,
"links": {},
"phoneNumber": "abc123",
"supervisor": User,
"supervisorId": "abc123",
"title": "xyz789"
}
}
}
tagDetail
Example
Query
query TagDetail($_id: String!) {
tagDetail(_id: $_id) {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"tagDetail": {
"_id": "abc123",
"colorCode": "xyz789",
"createdAt": "2007-12-03",
"name": "abc123",
"objectCount": 123,
"order": "xyz789",
"parentId": "abc123",
"relatedIds": ["abc123"],
"totalObjectCount": 987,
"type": "abc123"
}
}
}
taskDetail
Example
Query
query TaskDetail($_id: String!) {
taskDetail(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"taskDetail": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": true,
"isComplete": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 987,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
tasks
Response
Returns
[TaskListItem]
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
search -
String
|
|
segment -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
stageId -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query Tasks(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$search: String,
$segment: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$stageId: String,
$startDate: String,
$userIds: [String]
) {
tasks(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
search: $search,
segment: $segment,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
stageId: $stageId,
startDate: $startDate,
userIds: $userIds
) {
_id
assignedUsers
closeDate
companies
createdAt
customers
hasNotified
isComplete
isWatched
labels
modifiedAt
name
number
priority
relations
score
stage
startDate
}
}
Variables
{
"_ids": ["xyz789"],
"assignedToMe": "xyz789",
"assignedUserIds": ["xyz789"],
"closeDateType": "abc123",
"companyIds": ["abc123"],
"conformityIsRelated": true,
"conformityIsSaved": false,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "xyz789",
"customerIds": ["xyz789"],
"date": ItemDate,
"endDate": "abc123",
"hasStartAndCloseDate": true,
"labelIds": ["xyz789"],
"limit": 123,
"pipelineId": "abc123",
"priority": ["xyz789"],
"search": "xyz789",
"segment": "xyz789",
"skip": 987,
"sortDirection": 123,
"sortField": "xyz789",
"stageId": "xyz789",
"startDate": "xyz789",
"userIds": ["abc123"]
}
Response
{
"data": {
"tasks": [
{
"_id": "xyz789",
"assignedUsers": {},
"closeDate": "2007-12-03",
"companies": {},
"createdAt": "2007-12-03",
"customers": {},
"hasNotified": true,
"isComplete": true,
"isWatched": false,
"labels": {},
"modifiedAt": "2007-12-03",
"name": "xyz789",
"number": "xyz789",
"priority": "abc123",
"relations": {},
"score": 123.45,
"stage": {},
"startDate": "2007-12-03"
}
]
}
}
tasksAsLogs
Response
Returns
[JSON]
Example
Query
query TasksAsLogs(
$contentId: String!,
$contentType: String!,
$limit: Int
) {
tasksAsLogs(
contentId: $contentId,
contentType: $contentType,
limit: $limit
)
}
Variables
{
"contentId": "abc123",
"contentType": "abc123",
"limit": 987
}
Response
{"data": {"tasksAsLogs": [{}]}}
tasksTotalCount
Response
Returns an
Int
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
search -
String
|
|
segment -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
stageId -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query TasksTotalCount(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$search: String,
$segment: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$stageId: String,
$startDate: String,
$userIds: [String]
) {
tasksTotalCount(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
search: $search,
segment: $segment,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
stageId: $stageId,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"_ids": ["abc123"],
"assignedToMe": "abc123",
"assignedUserIds": ["xyz789"],
"closeDateType": "xyz789",
"companyIds": ["xyz789"],
"conformityIsRelated": true,
"conformityIsSaved": false,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "abc123",
"customerIds": ["xyz789"],
"date": ItemDate,
"endDate": "abc123",
"hasStartAndCloseDate": false,
"labelIds": ["abc123"],
"limit": 987,
"pipelineId": "xyz789",
"priority": ["abc123"],
"search": "abc123",
"segment": "xyz789",
"skip": 123,
"sortDirection": 123,
"sortField": "abc123",
"stageId": "abc123",
"startDate": "abc123",
"userIds": ["abc123"]
}
Response
{"data": {"tasksTotalCount": 123}}
ticketDetail
Example
Query
query TicketDetail($_id: String!) {
ticketDetail(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"ticketDetail": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": false,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 987.65,
"source": "xyz789",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
tickets
Response
Returns
[TicketListItem]
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
search -
String
|
|
segment -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
source -
[String]
|
|
stageId -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query Tickets(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$search: String,
$segment: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$source: [String],
$stageId: String,
$startDate: String,
$userIds: [String]
) {
tickets(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
search: $search,
segment: $segment,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
source: $source,
stageId: $stageId,
startDate: $startDate,
userIds: $userIds
) {
_id
assignedUsers
closeDate
companies
createdAt
customers
hasNotified
isComplete
isWatched
labels
modifiedAt
name
number
priority
relations
score
stage
startDate
}
}
Variables
{
"_ids": ["abc123"],
"assignedToMe": "abc123",
"assignedUserIds": ["abc123"],
"closeDateType": "xyz789",
"companyIds": ["xyz789"],
"conformityIsRelated": false,
"conformityIsSaved": true,
"conformityMainType": "abc123",
"conformityMainTypeId": "xyz789",
"conformityRelType": "xyz789",
"customerIds": ["xyz789"],
"date": ItemDate,
"endDate": "xyz789",
"hasStartAndCloseDate": true,
"labelIds": ["abc123"],
"limit": 123,
"pipelineId": "abc123",
"priority": ["xyz789"],
"search": "abc123",
"segment": "abc123",
"skip": 987,
"sortDirection": 123,
"sortField": "abc123",
"source": ["abc123"],
"stageId": "abc123",
"startDate": "abc123",
"userIds": ["abc123"]
}
Response
{
"data": {
"tickets": [
{
"_id": "abc123",
"assignedUsers": {},
"closeDate": "2007-12-03",
"companies": {},
"createdAt": "2007-12-03",
"customers": {},
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labels": {},
"modifiedAt": "2007-12-03",
"name": "abc123",
"number": "xyz789",
"priority": "abc123",
"relations": {},
"score": 123.45,
"stage": {},
"startDate": "2007-12-03"
}
]
}
}
ticketsTotalCount
Response
Returns an
Int
Arguments
| Name | Description |
|---|---|
_ids -
[String]
|
|
assignedToMe -
String
|
|
assignedUserIds -
[String]
|
|
closeDateType -
String
|
|
companyIds -
[String]
|
|
conformityIsRelated -
Boolean
|
|
conformityIsSaved -
Boolean
|
|
conformityMainType -
String
|
|
conformityMainTypeId -
String
|
|
conformityRelType -
String
|
|
customerIds -
[String]
|
|
date -
ItemDate
|
|
endDate -
String
|
|
hasStartAndCloseDate -
Boolean
|
|
labelIds -
[String]
|
|
limit -
Int
|
|
pipelineId -
String
|
|
priority -
[String]
|
|
search -
String
|
|
segment -
String
|
|
skip -
Int
|
|
sortDirection -
Int
|
|
sortField -
String
|
|
source -
[String]
|
|
stageId -
String
|
|
startDate -
String
|
|
userIds -
[String]
|
Example
Query
query TicketsTotalCount(
$_ids: [String],
$assignedToMe: String,
$assignedUserIds: [String],
$closeDateType: String,
$companyIds: [String],
$conformityIsRelated: Boolean,
$conformityIsSaved: Boolean,
$conformityMainType: String,
$conformityMainTypeId: String,
$conformityRelType: String,
$customerIds: [String],
$date: ItemDate,
$endDate: String,
$hasStartAndCloseDate: Boolean,
$labelIds: [String],
$limit: Int,
$pipelineId: String,
$priority: [String],
$search: String,
$segment: String,
$skip: Int,
$sortDirection: Int,
$sortField: String,
$source: [String],
$stageId: String,
$startDate: String,
$userIds: [String]
) {
ticketsTotalCount(
_ids: $_ids,
assignedToMe: $assignedToMe,
assignedUserIds: $assignedUserIds,
closeDateType: $closeDateType,
companyIds: $companyIds,
conformityIsRelated: $conformityIsRelated,
conformityIsSaved: $conformityIsSaved,
conformityMainType: $conformityMainType,
conformityMainTypeId: $conformityMainTypeId,
conformityRelType: $conformityRelType,
customerIds: $customerIds,
date: $date,
endDate: $endDate,
hasStartAndCloseDate: $hasStartAndCloseDate,
labelIds: $labelIds,
limit: $limit,
pipelineId: $pipelineId,
priority: $priority,
search: $search,
segment: $segment,
skip: $skip,
sortDirection: $sortDirection,
sortField: $sortField,
source: $source,
stageId: $stageId,
startDate: $startDate,
userIds: $userIds
)
}
Variables
{
"_ids": ["xyz789"],
"assignedToMe": "abc123",
"assignedUserIds": ["abc123"],
"closeDateType": "xyz789",
"companyIds": ["abc123"],
"conformityIsRelated": true,
"conformityIsSaved": true,
"conformityMainType": "xyz789",
"conformityMainTypeId": "abc123",
"conformityRelType": "abc123",
"customerIds": ["abc123"],
"date": ItemDate,
"endDate": "abc123",
"hasStartAndCloseDate": true,
"labelIds": ["xyz789"],
"limit": 123,
"pipelineId": "abc123",
"priority": ["xyz789"],
"search": "xyz789",
"segment": "abc123",
"skip": 987,
"sortDirection": 123,
"sortField": "abc123",
"source": ["abc123"],
"stageId": "xyz789",
"startDate": "xyz789",
"userIds": ["xyz789"]
}
Response
{"data": {"ticketsTotalCount": 987}}
transactionEmailDeliveries
Response
Returns an
EmailDeliveryList
Example
Query
query TransactionEmailDeliveries(
$page: Int,
$perPage: Int,
$searchValue: String
) {
transactionEmailDeliveries(
page: $page,
perPage: $perPage,
searchValue: $searchValue
) {
list {
_id
attachments
bcc
body
cc
createdAt
customerId
from
fromEmail
fromUser {
...UserFragment
}
kind
status
subject
to
userId
}
totalCount
}
}
Variables
{
"page": 123,
"perPage": 987,
"searchValue": "abc123"
}
Response
{
"data": {
"transactionEmailDeliveries": {
"list": [EmailDelivery],
"totalCount": 987
}
}
}
unitDetail
Example
Query
query UnitDetail($_id: String!) {
unitDetail(_id: $_id) {
_id
code
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
departmentId
description
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"unitDetail": {
"_id": "abc123",
"code": "abc123",
"department": Department,
"departmentId": "abc123",
"description": "abc123",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userIds": ["abc123"],
"users": [User]
}
}
}
units
Example
Query
query Units($searchValue: String) {
units(searchValue: $searchValue) {
_id
code
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
departmentId
description
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"searchValue": "xyz789"}
Response
{
"data": {
"units": [
{
"_id": "xyz789",
"code": "xyz789",
"department": Department,
"departmentId": "xyz789",
"description": "abc123",
"supervisor": User,
"supervisorId": "abc123",
"title": "abc123",
"userIds": ["xyz789"],
"users": [User]
}
]
}
}
userConversations
Response
Returns a
UserConversationListResponse
Example
Query
query UserConversations(
$_id: String,
$perPage: Int
) {
userConversations(
_id: $_id,
perPage: $perPage
) {
list {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
totalCount
}
}
Variables
{"_id": "abc123", "perPage": 123}
Response
{
"data": {
"userConversations": {
"list": [Conversation],
"totalCount": 987.65
}
}
}
userDetail
Example
Query
query UserDetail($_id: String) {
userDetail(_id: $_id) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"userDetail": {
"_id": "abc123",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "abc123",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "abc123",
"username": "xyz789"
}
}
}
users
Response
Returns
[User]
Example
Query
query Users(
$branchId: String,
$brandIds: [String],
$departmentId: String,
$excludeIds: Boolean,
$ids: [String],
$isActive: Boolean,
$page: Int,
$perPage: Int,
$requireUsername: Boolean,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String,
$unitId: String
) {
users(
branchId: $branchId,
brandIds: $brandIds,
departmentId: $departmentId,
excludeIds: $excludeIds,
ids: $ids,
isActive: $isActive,
page: $page,
perPage: $perPage,
requireUsername: $requireUsername,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status,
unitId: $unitId
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"branchId": "xyz789",
"brandIds": ["abc123"],
"departmentId": "xyz789",
"excludeIds": true,
"ids": ["abc123"],
"isActive": false,
"page": 123,
"perPage": 123,
"requireUsername": true,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "xyz789",
"status": "xyz789",
"unitId": "xyz789"
}
Response
{
"data": {
"users": [
{
"_id": "abc123",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["xyz789"],
"isActive": false,
"isOwner": true,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "xyz789",
"username": "abc123"
}
]
}
}
usersGroups
Response
Returns
[UsersGroup]
Example
Query
query UsersGroups(
$page: Int,
$perPage: Int
) {
usersGroups(
page: $page,
perPage: $perPage
) {
_id
description
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
}
}
Variables
{"page": 987, "perPage": 987}
Response
{
"data": {
"usersGroups": [
{
"_id": "abc123",
"description": "abc123",
"memberIds": ["abc123"],
"members": [User],
"name": "xyz789"
}
]
}
}
usersGroupsTotalCount
Response
Returns an
Int
Example
Query
query UsersGroupsTotalCount {
usersGroupsTotalCount
}
Response
{"data": {"usersGroupsTotalCount": 987}}
usersTotalCount
Response
Returns an
Int
Example
Query
query UsersTotalCount(
$branchId: String,
$brandIds: [String],
$departmentId: String,
$ids: [String],
$isActive: Boolean,
$requireUsername: Boolean,
$searchValue: String,
$unitId: String
) {
usersTotalCount(
branchId: $branchId,
brandIds: $brandIds,
departmentId: $departmentId,
ids: $ids,
isActive: $isActive,
requireUsername: $requireUsername,
searchValue: $searchValue,
unitId: $unitId
)
}
Variables
{
"branchId": "xyz789",
"brandIds": ["xyz789"],
"departmentId": "xyz789",
"ids": ["abc123"],
"isActive": false,
"requireUsername": false,
"searchValue": "xyz789",
"unitId": "xyz789"
}
Response
{"data": {"usersTotalCount": 987}}
voucherCampaignDetail
Response
Returns a
VoucherCampaign
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query VoucherCampaignDetail($_id: String!) {
voucherCampaignDetail(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
bonusCount
bonusProductId
buyScore
coupon
createdAt
createdBy
description
discountPercent
endDate
finishDateOfUse
lotteryCampaignId
lotteryCount
modifiedAt
modifiedBy
productCategoryIds
productIds
score
scoreAction
spinCampaignId
spinCount
startDate
status
title
voucherType
vouchersCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"voucherCampaignDetail": {
"_id": "abc123",
"attachment": Attachment,
"bonusCount": 987.65,
"bonusProductId": "abc123",
"buyScore": 123.45,
"coupon": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "xyz789",
"lotteryCount": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"productCategoryIds": ["xyz789"],
"productIds": ["xyz789"],
"score": 123.45,
"scoreAction": "abc123",
"spinCampaignId": "xyz789",
"spinCount": 987.65,
"startDate": "2007-12-03",
"status": "abc123",
"title": "xyz789",
"voucherType": "xyz789",
"vouchersCount": 123
}
}
}
voucherCampaigns
Response
Returns
[VoucherCampaign]
Example
Query
query VoucherCampaigns(
$equalTypeCampaignId: String,
$filterStatus: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$voucherType: String
) {
voucherCampaigns(
equalTypeCampaignId: $equalTypeCampaignId,
filterStatus: $filterStatus,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
voucherType: $voucherType
) {
_id
attachment {
duration
name
size
type
url
}
bonusCount
bonusProductId
buyScore
coupon
createdAt
createdBy
description
discountPercent
endDate
finishDateOfUse
lotteryCampaignId
lotteryCount
modifiedAt
modifiedBy
productCategoryIds
productIds
score
scoreAction
spinCampaignId
spinCount
startDate
status
title
voucherType
vouchersCount
}
}
Variables
{
"equalTypeCampaignId": "xyz789",
"filterStatus": "abc123",
"page": 123,
"perPage": 123,
"searchValue": "abc123",
"sortDirection": 987,
"sortField": "xyz789",
"voucherType": "xyz789"
}
Response
{
"data": {
"voucherCampaigns": [
{
"_id": "abc123",
"attachment": Attachment,
"bonusCount": 123.45,
"bonusProductId": "xyz789",
"buyScore": 987.65,
"coupon": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "xyz789",
"lotteryCount": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"productCategoryIds": ["abc123"],
"productIds": ["abc123"],
"score": 987.65,
"scoreAction": "xyz789",
"spinCampaignId": "xyz789",
"spinCount": 987.65,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789",
"voucherType": "abc123",
"vouchersCount": 123
}
]
}
}
voucherCampaignsCount
Example
Query
query VoucherCampaignsCount(
$filterStatus: String,
$searchValue: String
) {
voucherCampaignsCount(
filterStatus: $filterStatus,
searchValue: $searchValue
)
}
Variables
{
"filterStatus": "abc123",
"searchValue": "abc123"
}
Response
{"data": {"voucherCampaignsCount": 987}}
voucherDetail
Example
Query
query VoucherDetail($_id: String!) {
voucherDetail(_id: $_id) {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"voucherDetail": {
"_id": "abc123",
"bonusInfo": {},
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "abc123",
"ownerType": "xyz789",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123"
}
}
}
vouchers
Response
Returns
[Voucher]
Example
Query
query Vouchers(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String
) {
vouchers(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status
) {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
}
Variables
{
"campaignId": "abc123",
"ownerId": "xyz789",
"ownerType": "xyz789",
"page": 987,
"perPage": 987,
"searchValue": "abc123",
"sortDirection": 123,
"sortField": "xyz789",
"status": "xyz789"
}
Response
{
"data": {
"vouchers": [
{
"_id": "xyz789",
"bonusInfo": {},
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789"
}
]
}
}
vouchersMain
Response
Returns a
VoucherMain
Example
Query
query VouchersMain(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$page: Int,
$perPage: Int,
$searchValue: String,
$sortDirection: Int,
$sortField: String,
$status: String
) {
vouchersMain(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
page: $page,
perPage: $perPage,
searchValue: $searchValue,
sortDirection: $sortDirection,
sortField: $sortField,
status: $status
) {
list {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
totalCount
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "abc123",
"ownerType": "xyz789",
"page": 123,
"perPage": 987,
"searchValue": "xyz789",
"sortDirection": 987,
"sortField": "xyz789",
"status": "xyz789"
}
Response
{
"data": {
"vouchersMain": {"list": [Voucher], "totalCount": 987}
}
}
widgetsBookingProductWithFields
Response
Returns a
BookingProduct
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query WidgetsBookingProductWithFields($_id: String!) {
widgetsBookingProductWithFields(_id: $_id) {
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
product {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"widgetsBookingProductWithFields": {
"fields": [Field],
"product": Product
}
}
}
widgetsConversationDetail
Response
Returns a
ConversationDetailResponse
Example
Query
query WidgetsConversationDetail(
$_id: String,
$integrationId: String!
) {
widgetsConversationDetail(
_id: $_id,
integrationId: $integrationId
) {
_id
isOnline
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
operatorStatus
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supporters {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "abc123",
"integrationId": "abc123"
}
Response
{
"data": {
"widgetsConversationDetail": {
"_id": "xyz789",
"isOnline": true,
"messages": [ConversationMessage],
"operatorStatus": "xyz789",
"participatedUsers": [User],
"supporters": [User]
}
}
}
widgetsConversations
Response
Returns
[Conversation]
Example
Query
query WidgetsConversations(
$customerId: String,
$integrationId: String!,
$visitorId: String
) {
widgetsConversations(
customerId: $customerId,
integrationId: $integrationId,
visitorId: $visitorId
) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"customerId": "abc123",
"integrationId": "xyz789",
"visitorId": "abc123"
}
Response
{
"data": {
"widgetsConversations": [
{
"_id": "abc123",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "abc123",
"callProAudio": "xyz789",
"content": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "xyz789",
"facebookPost": FacebookPost,
"idleTime": 987.65,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": false,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 987,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 123,
"readUserIds": ["xyz789"],
"status": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
]
}
}
widgetsGetEngageMessage
Response
Returns a
ConversationMessage
Example
Query
query WidgetsGetEngageMessage(
$browserInfo: JSON!,
$customerId: String,
$integrationId: String,
$visitorId: String
) {
widgetsGetEngageMessage(
browserInfo: $browserInfo,
customerId: $customerId,
integrationId: $integrationId,
visitorId: $visitorId
) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"browserInfo": {},
"customerId": "abc123",
"integrationId": "xyz789",
"visitorId": "abc123"
}
Response
{
"data": {
"widgetsGetEngageMessage": {
"_id": "abc123",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "abc123",
"contentType": "abc123",
"conversationId": "abc123",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "xyz789",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": false,
"internal": true,
"isCustomerRead": false,
"mailData": MailData,
"mentionedUserIds": ["xyz789"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
widgetsGetMessengerIntegration
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
brandCode -
String!
|
Example
Query
query WidgetsGetMessengerIntegration($brandCode: String!) {
widgetsGetMessengerIntegration(brandCode: $brandCode) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{"brandCode": "abc123"}
Response
{
"data": {
"widgetsGetMessengerIntegration": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["abc123"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
widgetsKnowledgeBaseArticles
Response
Returns
[KnowledgeBaseArticle]
Example
Query
query WidgetsKnowledgeBaseArticles(
$searchString: String,
$topicId: String!
) {
widgetsKnowledgeBaseArticles(
searchString: $searchString,
topicId: $topicId
) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{
"searchString": "abc123",
"topicId": "abc123"
}
Response
{
"data": {
"widgetsKnowledgeBaseArticles": [
{
"_id": "abc123",
"attachments": [Attachment],
"categoryId": "abc123",
"content": "abc123",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"reactionChoices": ["abc123"],
"reactionCounts": {},
"status": "abc123",
"summary": "abc123",
"title": "abc123",
"topicId": "xyz789",
"viewCount": 123
}
]
}
}
widgetsKnowledgeBaseTopicDetail
Response
Returns a
KnowledgeBaseTopic
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query WidgetsKnowledgeBaseTopicDetail($_id: String!) {
widgetsKnowledgeBaseTopicDetail(_id: $_id) {
_id
backgroundImage
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
categories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
childrens {
...KnowledgeBaseCategoryFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
title
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"widgetsKnowledgeBaseTopicDetail": {
"_id": "abc123",
"backgroundImage": "abc123",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "xyz789",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "abc123",
"languageCode": "xyz789",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "xyz789"
}
}
}
widgetsMessages
Response
Returns
[ConversationMessage]
Arguments
| Name | Description |
|---|---|
conversationId -
String
|
Example
Query
query WidgetsMessages($conversationId: String) {
widgetsMessages(conversationId: $conversationId) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{"conversationId": "abc123"}
Response
{
"data": {
"widgetsMessages": [
{
"_id": "xyz789",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "abc123",
"contentType": "xyz789",
"conversationId": "xyz789",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "abc123",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": false,
"internal": true,
"isCustomerRead": false,
"mailData": MailData,
"mentionedUserIds": ["xyz789"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
]
}
}
widgetsMessengerSupporters
Response
Returns a
MessengerSupportersResponse
Arguments
| Name | Description |
|---|---|
integrationId -
String!
|
Example
Query
query WidgetsMessengerSupporters($integrationId: String!) {
widgetsMessengerSupporters(integrationId: $integrationId) {
isOnline
serverTime
supporters {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"integrationId": "abc123"}
Response
{
"data": {
"widgetsMessengerSupporters": {
"isOnline": true,
"serverTime": "abc123",
"supporters": [User]
}
}
}
widgetsProductCategory
Response
Returns a
ProductCategory
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
query WidgetsProductCategory($_id: String!) {
widgetsProductCategory(_id: $_id) {
_id
attachment {
duration
name
size
type
url
}
code
description
isRoot
name
order
parentId
productCount
status
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"widgetsProductCategory": {
"_id": "xyz789",
"attachment": Attachment,
"code": "xyz789",
"description": "abc123",
"isRoot": false,
"name": "xyz789",
"order": "xyz789",
"parentId": "abc123",
"productCount": 123,
"status": "abc123"
}
}
}
widgetsTotalUnreadCount
Response
Returns an
Int
Example
Query
query WidgetsTotalUnreadCount(
$customerId: String,
$integrationId: String!,
$visitorId: String
) {
widgetsTotalUnreadCount(
customerId: $customerId,
integrationId: $integrationId,
visitorId: $visitorId
)
}
Variables
{
"customerId": "abc123",
"integrationId": "xyz789",
"visitorId": "abc123"
}
Response
{"data": {"widgetsTotalUnreadCount": 123}}
widgetsUnreadCount
Mutations
addUserSkills
Example
Query
mutation AddUserSkills(
$memberId: String!,
$skillIds: [String]!
) {
addUserSkills(
memberId: $memberId,
skillIds: $skillIds
)
}
Variables
{
"memberId": "abc123",
"skillIds": ["abc123"]
}
Response
{"data": {"addUserSkills": {}}}
appsAdd
Response
Returns an
App
Example
Query
mutation AppsAdd(
$expireDate: Date,
$name: String,
$userGroupId: String
) {
appsAdd(
expireDate: $expireDate,
name: $name,
userGroupId: $userGroupId
) {
_id
accessToken
createdAt
expireDate
isEnabled
name
refreshToken
userGroupId
userGroupName
}
}
Variables
{
"expireDate": "2007-12-03",
"name": "xyz789",
"userGroupId": "xyz789"
}
Response
{
"data": {
"appsAdd": {
"_id": "xyz789",
"accessToken": "xyz789",
"createdAt": "2007-12-03",
"expireDate": "2007-12-03",
"isEnabled": true,
"name": "abc123",
"refreshToken": "xyz789",
"userGroupId": "abc123",
"userGroupName": "xyz789"
}
}
}
appsEdit
Response
Returns an
App
Example
Query
mutation AppsEdit(
$_id: String!,
$expireDate: Date,
$name: String,
$userGroupId: String
) {
appsEdit(
_id: $_id,
expireDate: $expireDate,
name: $name,
userGroupId: $userGroupId
) {
_id
accessToken
createdAt
expireDate
isEnabled
name
refreshToken
userGroupId
userGroupName
}
}
Variables
{
"_id": "xyz789",
"expireDate": "2007-12-03",
"name": "xyz789",
"userGroupId": "xyz789"
}
Response
{
"data": {
"appsEdit": {
"_id": "xyz789",
"accessToken": "abc123",
"createdAt": "2007-12-03",
"expireDate": "2007-12-03",
"isEnabled": false,
"name": "abc123",
"refreshToken": "abc123",
"userGroupId": "xyz789",
"userGroupName": "abc123"
}
}
}
appsRemove
automationsAdd
Response
Returns an
Automation
Arguments
| Name | Description |
|---|---|
actions -
[ActionInput]
|
|
name -
String
|
|
status -
String
|
|
triggers -
[TriggerInput]
|
Example
Query
mutation AutomationsAdd(
$actions: [ActionInput],
$name: String,
$status: String,
$triggers: [TriggerInput]
) {
automationsAdd(
actions: $actions,
name: $name,
status: $status,
triggers: $triggers
) {
_id
actions {
config
description
icon
id
label
nextActionId
style
type
}
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
status
triggers {
actionId
config
count
description
icon
id
label
style
type
}
updatedAt
updatedBy
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"actions": [ActionInput],
"name": "abc123",
"status": "xyz789",
"triggers": [TriggerInput]
}
Response
{
"data": {
"automationsAdd": {
"_id": "xyz789",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUser": User,
"name": "xyz789",
"status": "xyz789",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "xyz789",
"updatedUser": User
}
}
}
automationsAddNote
Response
Returns an
AutomationNote
Example
Query
mutation AutomationsAddNote(
$actionId: String,
$automationId: String,
$description: String,
$triggerId: String
) {
automationsAddNote(
actionId: $actionId,
automationId: $automationId,
description: $description,
triggerId: $triggerId
) {
_id
actionId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
triggerId
}
}
Variables
{
"actionId": "xyz789",
"automationId": "xyz789",
"description": "abc123",
"triggerId": "abc123"
}
Response
{
"data": {
"automationsAddNote": {
"_id": "xyz789",
"actionId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "xyz789",
"triggerId": "xyz789"
}
}
}
automationsCreateFromTemplate
Response
Returns an
Automation
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
mutation AutomationsCreateFromTemplate($_id: String) {
automationsCreateFromTemplate(_id: $_id) {
_id
actions {
config
description
icon
id
label
nextActionId
style
type
}
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
status
triggers {
actionId
config
count
description
icon
id
label
style
type
}
updatedAt
updatedBy
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"automationsCreateFromTemplate": {
"_id": "xyz789",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUser": User,
"name": "abc123",
"status": "abc123",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "abc123",
"updatedUser": User
}
}
}
automationsEdit
Response
Returns an
Automation
Arguments
| Name | Description |
|---|---|
_id -
String
|
|
actions -
[ActionInput]
|
|
name -
String
|
|
status -
String
|
|
triggers -
[TriggerInput]
|
Example
Query
mutation AutomationsEdit(
$_id: String,
$actions: [ActionInput],
$name: String,
$status: String,
$triggers: [TriggerInput]
) {
automationsEdit(
_id: $_id,
actions: $actions,
name: $name,
status: $status,
triggers: $triggers
) {
_id
actions {
config
description
icon
id
label
nextActionId
style
type
}
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
status
triggers {
actionId
config
count
description
icon
id
label
style
type
}
updatedAt
updatedBy
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "xyz789",
"actions": [ActionInput],
"name": "xyz789",
"status": "abc123",
"triggers": [TriggerInput]
}
Response
{
"data": {
"automationsEdit": {
"_id": "abc123",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"name": "xyz789",
"status": "abc123",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "abc123",
"updatedUser": User
}
}
}
automationsEditNote
Response
Returns an
AutomationNote
Example
Query
mutation AutomationsEditNote(
$_id: String!,
$actionId: String,
$automationId: String,
$description: String,
$triggerId: String
) {
automationsEditNote(
_id: $_id,
actionId: $actionId,
automationId: $automationId,
description: $description,
triggerId: $triggerId
) {
_id
actionId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
triggerId
}
}
Variables
{
"_id": "abc123",
"actionId": "abc123",
"automationId": "xyz789",
"description": "abc123",
"triggerId": "abc123"
}
Response
{
"data": {
"automationsEditNote": {
"_id": "xyz789",
"actionId": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "xyz789",
"triggerId": "xyz789"
}
}
}
automationsRemove
automationsRemoveNote
Response
Returns an
AutomationNote
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation AutomationsRemoveNote($_id: String!) {
automationsRemoveNote(_id: $_id) {
_id
actionId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
triggerId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"automationsRemoveNote": {
"_id": "xyz789",
"actionId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "abc123",
"triggerId": "xyz789"
}
}
}
automationsSaveAsTemplate
Response
Returns an
Automation
Example
Query
mutation AutomationsSaveAsTemplate(
$_id: String!,
$duplicate: Boolean,
$name: String
) {
automationsSaveAsTemplate(
_id: $_id,
duplicate: $duplicate,
name: $name
) {
_id
actions {
config
description
icon
id
label
nextActionId
style
type
}
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
status
triggers {
actionId
config
count
description
icon
id
label
style
type
}
updatedAt
updatedBy
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "xyz789",
"duplicate": false,
"name": "xyz789"
}
Response
{
"data": {
"automationsSaveAsTemplate": {
"_id": "xyz789",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"name": "xyz789",
"status": "abc123",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "xyz789",
"updatedUser": User
}
}
}
boardItemUpdateTimeTracking
Response
Returns a
JSON
Example
Query
mutation BoardItemUpdateTimeTracking(
$_id: String!,
$startDate: String,
$status: String!,
$timeSpent: Int!,
$type: String!
) {
boardItemUpdateTimeTracking(
_id: $_id,
startDate: $startDate,
status: $status,
timeSpent: $timeSpent,
type: $type
)
}
Variables
{
"_id": "xyz789",
"startDate": "xyz789",
"status": "xyz789",
"timeSpent": 123,
"type": "xyz789"
}
Response
{"data": {"boardItemUpdateTimeTracking": {}}}
boardItemsSaveForGanttTimeline
Example
Query
mutation BoardItemsSaveForGanttTimeline(
$items: JSON,
$links: JSON,
$type: String!
) {
boardItemsSaveForGanttTimeline(
items: $items,
links: $links,
type: $type
)
}
Variables
{"items": {}, "links": {}, "type": "abc123"}
Response
{
"data": {
"boardItemsSaveForGanttTimeline": "xyz789"
}
}
boardsAdd
Example
Query
mutation BoardsAdd(
$name: String!,
$type: String!
) {
boardsAdd(
name: $name,
type: $type
) {
_id
createdAt
name
order
pipelines {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
type
}
}
Variables
{
"name": "xyz789",
"type": "abc123"
}
Response
{
"data": {
"boardsAdd": {
"_id": "xyz789",
"createdAt": "2007-12-03",
"name": "abc123",
"order": 123,
"pipelines": [Pipeline],
"type": "abc123"
}
}
}
boardsEdit
Example
Query
mutation BoardsEdit(
$_id: String!,
$name: String!,
$type: String!
) {
boardsEdit(
_id: $_id,
name: $name,
type: $type
) {
_id
createdAt
name
order
pipelines {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
type
}
}
Variables
{
"_id": "abc123",
"name": "abc123",
"type": "xyz789"
}
Response
{
"data": {
"boardsEdit": {
"_id": "abc123",
"createdAt": "2007-12-03",
"name": "abc123",
"order": 987,
"pipelines": [Pipeline],
"type": "abc123"
}
}
}
boardsRemove
branchesAdd
Response
Returns a
Branch
Example
Query
mutation BranchesAdd(
$address: String,
$code: String,
$coordinate: CoordinateInput,
$email: String,
$image: AttachmentInput,
$links: JSON,
$parentId: String,
$phoneNumber: String,
$supervisorId: String,
$title: String,
$userIds: [String]
) {
branchesAdd(
address: $address,
code: $code,
coordinate: $coordinate,
email: $email,
image: $image,
links: $links,
parentId: $parentId,
phoneNumber: $phoneNumber,
supervisorId: $supervisorId,
title: $title,
userIds: $userIds
) {
_id
address
children {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
code
coordinate {
latitude
longitude
}
email
image {
duration
name
size
type
url
}
links
parent {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
parentId
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"address": "xyz789",
"code": "abc123",
"coordinate": CoordinateInput,
"email": "xyz789",
"image": AttachmentInput,
"links": {},
"parentId": "abc123",
"phoneNumber": "abc123",
"supervisorId": "xyz789",
"title": "xyz789",
"userIds": ["xyz789"]
}
Response
{
"data": {
"branchesAdd": {
"_id": "xyz789",
"address": "abc123",
"children": [Branch],
"code": "abc123",
"coordinate": Coordinate,
"email": "abc123",
"image": Attachment,
"links": {},
"parent": Branch,
"parentId": "abc123",
"phoneNumber": "xyz789",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userIds": ["xyz789"],
"users": [User]
}
}
}
branchesEdit
Response
Returns a
Branch
Example
Query
mutation BranchesEdit(
$_id: String!,
$address: String,
$code: String,
$coordinate: CoordinateInput,
$email: String,
$image: AttachmentInput,
$links: JSON,
$parentId: String,
$phoneNumber: String,
$supervisorId: String,
$title: String,
$userIds: [String]
) {
branchesEdit(
_id: $_id,
address: $address,
code: $code,
coordinate: $coordinate,
email: $email,
image: $image,
links: $links,
parentId: $parentId,
phoneNumber: $phoneNumber,
supervisorId: $supervisorId,
title: $title,
userIds: $userIds
) {
_id
address
children {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
code
coordinate {
latitude
longitude
}
email
image {
duration
name
size
type
url
}
links
parent {
_id
address
children {
...BranchFragment
}
code
coordinate {
...CoordinateFragment
}
email
image {
...AttachmentFragment
}
links
parent {
...BranchFragment
}
parentId
phoneNumber
supervisor {
...UserFragment
}
supervisorId
title
userIds
users {
...UserFragment
}
}
parentId
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "abc123",
"address": "xyz789",
"code": "abc123",
"coordinate": CoordinateInput,
"email": "xyz789",
"image": AttachmentInput,
"links": {},
"parentId": "xyz789",
"phoneNumber": "xyz789",
"supervisorId": "xyz789",
"title": "abc123",
"userIds": ["xyz789"]
}
Response
{
"data": {
"branchesEdit": {
"_id": "xyz789",
"address": "xyz789",
"children": [Branch],
"code": "abc123",
"coordinate": Coordinate,
"email": "xyz789",
"image": Attachment,
"links": {},
"parent": Branch,
"parentId": "xyz789",
"phoneNumber": "xyz789",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userIds": ["xyz789"],
"users": [User]
}
}
}
branchesRemove
brandsAdd
Response
Returns a
Brand
Example
Query
mutation BrandsAdd(
$description: String,
$emailConfig: JSON,
$name: String!
) {
brandsAdd(
description: $description,
emailConfig: $emailConfig,
name: $name
) {
_id
code
createdAt
description
emailConfig
name
userId
}
}
Variables
{
"description": "xyz789",
"emailConfig": {},
"name": "abc123"
}
Response
{
"data": {
"brandsAdd": {
"_id": "abc123",
"code": "xyz789",
"createdAt": "2007-12-03",
"description": "xyz789",
"emailConfig": {},
"name": "xyz789",
"userId": "xyz789"
}
}
}
brandsEdit
Response
Returns a
Brand
Example
Query
mutation BrandsEdit(
$_id: String!,
$description: String,
$emailConfig: JSON,
$name: String!
) {
brandsEdit(
_id: $_id,
description: $description,
emailConfig: $emailConfig,
name: $name
) {
_id
code
createdAt
description
emailConfig
name
userId
}
}
Variables
{
"_id": "xyz789",
"description": "xyz789",
"emailConfig": {},
"name": "abc123"
}
Response
{
"data": {
"brandsEdit": {
"_id": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"description": "xyz789",
"emailConfig": {},
"name": "abc123",
"userId": "abc123"
}
}
}
brandsRemove
buyLottery
Response
Returns a
Lottery
Example
Query
mutation BuyLottery(
$campaignId: String,
$count: Int,
$ownerId: String,
$ownerType: String
) {
buyLottery(
campaignId: $campaignId,
count: $count,
ownerId: $ownerId,
ownerType: $ownerType
) {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "abc123",
"count": 987,
"ownerId": "abc123",
"ownerType": "abc123"
}
Response
{
"data": {
"buyLottery": {
"_id": "abc123",
"awardId": "abc123",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"number": "abc123",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
}
}
buySpin
Response
Returns a
Spin
Example
Query
mutation BuySpin(
$campaignId: String,
$count: Int,
$ownerId: String,
$ownerType: String
) {
buySpin(
campaignId: $campaignId,
count: $count,
ownerId: $ownerId,
ownerType: $ownerType
) {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "xyz789",
"count": 123,
"ownerId": "xyz789",
"ownerType": "xyz789"
}
Response
{
"data": {
"buySpin": {
"_id": "xyz789",
"awardId": "xyz789",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
}
}
buyVoucher
Response
Returns a
Voucher
Example
Query
mutation BuyVoucher(
$campaignId: String,
$count: Int,
$ownerId: String,
$ownerType: String
) {
buyVoucher(
campaignId: $campaignId,
count: $count,
ownerId: $ownerId,
ownerType: $ownerType
) {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
}
Variables
{
"campaignId": "xyz789",
"count": 123,
"ownerId": "xyz789",
"ownerType": "abc123"
}
Response
{
"data": {
"buyVoucher": {
"_id": "abc123",
"bonusInfo": {},
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123"
}
}
}
changeConversationOperator
Example
Query
mutation ChangeConversationOperator(
$_id: String!,
$operatorStatus: String!
) {
changeConversationOperator(
_id: $_id,
operatorStatus: $operatorStatus
)
}
Variables
{
"_id": "xyz789",
"operatorStatus": "xyz789"
}
Response
{"data": {"changeConversationOperator": {}}}
channelsAdd
Response
Returns a
Channel
Example
Query
mutation ChannelsAdd(
$description: String,
$integrationIds: [String],
$memberIds: [String],
$name: String!
) {
channelsAdd(
description: $description,
integrationIds: $integrationIds,
memberIds: $memberIds,
name: $name
) {
_id
conversationCount
createdAt
description
integrationIds
integrations {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
openConversationCount
userId
}
}
Variables
{
"description": "xyz789",
"integrationIds": ["xyz789"],
"memberIds": ["xyz789"],
"name": "xyz789"
}
Response
{
"data": {
"channelsAdd": {
"_id": "xyz789",
"conversationCount": 123,
"createdAt": "2007-12-03",
"description": "abc123",
"integrationIds": ["abc123"],
"integrations": [Integration],
"memberIds": ["xyz789"],
"members": [User],
"name": "xyz789",
"openConversationCount": 123,
"userId": "abc123"
}
}
}
channelsEdit
Response
Returns a
Channel
Example
Query
mutation ChannelsEdit(
$_id: String!,
$description: String,
$integrationIds: [String],
$memberIds: [String],
$name: String!
) {
channelsEdit(
_id: $_id,
description: $description,
integrationIds: $integrationIds,
memberIds: $memberIds,
name: $name
) {
_id
conversationCount
createdAt
description
integrationIds
integrations {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
openConversationCount
userId
}
}
Variables
{
"_id": "abc123",
"description": "xyz789",
"integrationIds": ["abc123"],
"memberIds": ["xyz789"],
"name": "abc123"
}
Response
{
"data": {
"channelsEdit": {
"_id": "abc123",
"conversationCount": 123,
"createdAt": "2007-12-03",
"description": "abc123",
"integrationIds": ["xyz789"],
"integrations": [Integration],
"memberIds": ["abc123"],
"members": [User],
"name": "xyz789",
"openConversationCount": 123,
"userId": "xyz789"
}
}
}
channelsRemove
chatAdd
Response
Returns a
Chat
Arguments
| Name | Description |
|---|---|
description -
String
|
|
name -
String
|
|
participantIds -
[String]
|
|
type -
ChatType!
|
|
visibility -
ChatVisibilityType
|
Example
Query
mutation ChatAdd(
$description: String,
$name: String,
$participantIds: [String],
$type: ChatType!,
$visibility: ChatVisibilityType
) {
chatAdd(
description: $description,
name: $name,
participantIds: $participantIds,
type: $type,
visibility: $visibility
) {
_id
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
isSeen
lastMessage {
_id
attachments
content
createdAt
createdUser {
...UserFragment
}
isPinned
mentionedUserIds
relatedMessage {
...ChatMessageFragment
}
seenList {
...SeenInfoFragment
}
}
name
participantUsers {
_id
details {
...ChatUserDetailsFragment
}
email
isAdmin
username
}
type
visibility
}
}
Variables
{
"description": "abc123",
"name": "abc123",
"participantIds": ["abc123"],
"type": "direct",
"visibility": "private"
}
Response
{
"data": {
"chatAdd": {
"_id": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "abc123",
"isSeen": true,
"lastMessage": ChatMessage,
"name": "abc123",
"participantUsers": [ChatUser],
"type": "xyz789",
"visibility": "xyz789"
}
}
}
chatAddOrRemoveMember
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
type -
ChatMemberModifyType
|
|
userIds -
[String]
|
Example
Query
mutation ChatAddOrRemoveMember(
$_id: String!,
$type: ChatMemberModifyType,
$userIds: [String]
) {
chatAddOrRemoveMember(
_id: $_id,
type: $type,
userIds: $userIds
)
}
Variables
{
"_id": "abc123",
"type": "add",
"userIds": ["abc123"]
}
Response
{
"data": {
"chatAddOrRemoveMember": "abc123"
}
}
chatEdit
Response
Returns a
Chat
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
description -
String
|
|
name -
String
|
|
visibility -
ChatVisibilityType
|
Example
Query
mutation ChatEdit(
$_id: String!,
$description: String,
$name: String,
$visibility: ChatVisibilityType
) {
chatEdit(
_id: $_id,
description: $description,
name: $name,
visibility: $visibility
) {
_id
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
isSeen
lastMessage {
_id
attachments
content
createdAt
createdUser {
...UserFragment
}
isPinned
mentionedUserIds
relatedMessage {
...ChatMessageFragment
}
seenList {
...SeenInfoFragment
}
}
name
participantUsers {
_id
details {
...ChatUserDetailsFragment
}
email
isAdmin
username
}
type
visibility
}
}
Variables
{
"_id": "xyz789",
"description": "abc123",
"name": "xyz789",
"visibility": "private"
}
Response
{
"data": {
"chatEdit": {
"_id": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "xyz789",
"isSeen": true,
"lastMessage": ChatMessage,
"name": "abc123",
"participantUsers": [ChatUser],
"type": "xyz789",
"visibility": "abc123"
}
}
}
chatMakeOrRemoveAdmin
Example
Query
mutation ChatMakeOrRemoveAdmin(
$_id: String!,
$userId: String!
) {
chatMakeOrRemoveAdmin(
_id: $_id,
userId: $userId
)
}
Variables
{
"_id": "xyz789",
"userId": "xyz789"
}
Response
{
"data": {
"chatMakeOrRemoveAdmin": "xyz789"
}
}
chatMarkAsRead
chatMessageAdd
Response
Returns a
ChatMessage
Example
Query
mutation ChatMessageAdd(
$attachments: [JSON],
$chatId: String!,
$content: String,
$mentionedUserIds: [String],
$relatedId: String
) {
chatMessageAdd(
attachments: $attachments,
chatId: $chatId,
content: $content,
mentionedUserIds: $mentionedUserIds,
relatedId: $relatedId
) {
_id
attachments
content
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
isPinned
mentionedUserIds
relatedMessage {
_id
attachments
content
createdAt
createdUser {
...UserFragment
}
isPinned
mentionedUserIds
relatedMessage {
...ChatMessageFragment
}
seenList {
...SeenInfoFragment
}
}
seenList {
lastSeenMessageId
seenDate
user {
...UserFragment
}
}
}
}
Variables
{
"attachments": [{}],
"chatId": "abc123",
"content": "abc123",
"mentionedUserIds": ["abc123"],
"relatedId": "xyz789"
}
Response
{
"data": {
"chatMessageAdd": {
"_id": "xyz789",
"attachments": {},
"content": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"isPinned": true,
"mentionedUserIds": ["abc123"],
"relatedMessage": ChatMessage,
"seenList": [SeenInfo]
}
}
}
chatMessageRemove
chatMessageToggleIsPinned
chatRemove
chatTypingInfo
Example
Query
mutation ChatTypingInfo(
$chatId: String!,
$userId: String!
) {
chatTypingInfo(
chatId: $chatId,
userId: $userId
)
}
Variables
{
"chatId": "xyz789",
"userId": "xyz789"
}
Response
{"data": {"chatTypingInfo": "abc123"}}
checklistItemsAdd
Response
Returns a
ChecklistItem
Example
Query
mutation ChecklistItemsAdd(
$checklistId: String,
$content: String,
$isChecked: Boolean
) {
checklistItemsAdd(
checklistId: $checklistId,
content: $content,
isChecked: $isChecked
) {
_id
checklistId
content
isChecked
order
}
}
Variables
{
"checklistId": "abc123",
"content": "abc123",
"isChecked": true
}
Response
{
"data": {
"checklistItemsAdd": {
"_id": "abc123",
"checklistId": "abc123",
"content": "abc123",
"isChecked": false,
"order": 123
}
}
}
checklistItemsEdit
Response
Returns a
ChecklistItem
Example
Query
mutation ChecklistItemsEdit(
$_id: String!,
$checklistId: String,
$content: String,
$isChecked: Boolean
) {
checklistItemsEdit(
_id: $_id,
checklistId: $checklistId,
content: $content,
isChecked: $isChecked
) {
_id
checklistId
content
isChecked
order
}
}
Variables
{
"_id": "xyz789",
"checklistId": "abc123",
"content": "xyz789",
"isChecked": false
}
Response
{
"data": {
"checklistItemsEdit": {
"_id": "abc123",
"checklistId": "abc123",
"content": "abc123",
"isChecked": false,
"order": 987
}
}
}
checklistItemsOrder
Response
Returns a
ChecklistItem
Example
Query
mutation ChecklistItemsOrder(
$_id: String!,
$destinationIndex: Int
) {
checklistItemsOrder(
_id: $_id,
destinationIndex: $destinationIndex
) {
_id
checklistId
content
isChecked
order
}
}
Variables
{"_id": "abc123", "destinationIndex": 123}
Response
{
"data": {
"checklistItemsOrder": {
"_id": "abc123",
"checklistId": "abc123",
"content": "xyz789",
"isChecked": false,
"order": 987
}
}
}
checklistItemsRemove
Response
Returns a
ChecklistItem
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation ChecklistItemsRemove($_id: String!) {
checklistItemsRemove(_id: $_id) {
_id
checklistId
content
isChecked
order
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"checklistItemsRemove": {
"_id": "abc123",
"checklistId": "xyz789",
"content": "abc123",
"isChecked": false,
"order": 987
}
}
}
checklistsAdd
Response
Returns a
Checklist
Example
Query
mutation ChecklistsAdd(
$contentType: String,
$contentTypeId: String,
$title: String
) {
checklistsAdd(
contentType: $contentType,
contentTypeId: $contentTypeId,
title: $title
) {
_id
contentType
contentTypeId
createdDate
createdUserId
items {
_id
checklistId
content
isChecked
order
}
percent
title
}
}
Variables
{
"contentType": "xyz789",
"contentTypeId": "xyz789",
"title": "abc123"
}
Response
{
"data": {
"checklistsAdd": {
"_id": "abc123",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"createdDate": "2007-12-03",
"createdUserId": "xyz789",
"items": [ChecklistItem],
"percent": 987.65,
"title": "xyz789"
}
}
}
checklistsEdit
Response
Returns a
Checklist
Example
Query
mutation ChecklistsEdit(
$_id: String!,
$contentType: String,
$contentTypeId: String,
$title: String
) {
checklistsEdit(
_id: $_id,
contentType: $contentType,
contentTypeId: $contentTypeId,
title: $title
) {
_id
contentType
contentTypeId
createdDate
createdUserId
items {
_id
checklistId
content
isChecked
order
}
percent
title
}
}
Variables
{
"_id": "abc123",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"title": "abc123"
}
Response
{
"data": {
"checklistsEdit": {
"_id": "abc123",
"contentType": "xyz789",
"contentTypeId": "abc123",
"createdDate": "2007-12-03",
"createdUserId": "xyz789",
"items": [ChecklistItem],
"percent": 987.65,
"title": "xyz789"
}
}
}
checklistsRemove
Example
Query
mutation ChecklistsRemove($_id: String!) {
checklistsRemove(_id: $_id) {
_id
contentType
contentTypeId
createdDate
createdUserId
items {
_id
checklistId
content
isChecked
order
}
percent
title
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"checklistsRemove": {
"_id": "abc123",
"contentType": "abc123",
"contentTypeId": "abc123",
"createdDate": "2007-12-03",
"createdUserId": "xyz789",
"items": [ChecklistItem],
"percent": 987.65,
"title": "abc123"
}
}
}
clientPortalConfigUpdate
Response
Returns a
ClientPortal
Arguments
| Name | Description |
|---|---|
_id -
String
|
|
description -
String
|
|
domain -
String
|
|
footerHtml -
String
|
|
googleCredentials -
JSON
|
|
headerHtml -
String
|
|
icon -
String
|
|
kbToggle -
Boolean
|
|
knowledgeBaseLabel -
String
|
|
knowledgeBaseTopicId -
String
|
|
logo -
String
|
|
messengerBrandCode -
String
|
|
mobileResponsive -
Boolean
|
|
name -
String
|
|
otpConfig -
OTPConfigInput
|
|
publicTaskToggle -
Boolean
|
|
styles -
StylesParams
|
|
taskBoardId -
String
|
|
taskLabel -
String
|
|
taskPipelineId -
String
|
|
taskPublicBoardId -
String
|
|
taskPublicPipelineId -
String
|
|
taskStageId -
String
|
|
taskToggle -
Boolean
|
|
ticketBoardId -
String
|
|
ticketLabel -
String
|
|
ticketPipelineId -
String
|
|
ticketStageId -
String
|
|
ticketToggle -
Boolean
|
|
url -
String
|
Example
Query
mutation ClientPortalConfigUpdate(
$_id: String,
$description: String,
$domain: String,
$footerHtml: String,
$googleCredentials: JSON,
$headerHtml: String,
$icon: String,
$kbToggle: Boolean,
$knowledgeBaseLabel: String,
$knowledgeBaseTopicId: String,
$logo: String,
$messengerBrandCode: String,
$mobileResponsive: Boolean,
$name: String,
$otpConfig: OTPConfigInput,
$publicTaskToggle: Boolean,
$styles: StylesParams,
$taskBoardId: String,
$taskLabel: String,
$taskPipelineId: String,
$taskPublicBoardId: String,
$taskPublicPipelineId: String,
$taskStageId: String,
$taskToggle: Boolean,
$ticketBoardId: String,
$ticketLabel: String,
$ticketPipelineId: String,
$ticketStageId: String,
$ticketToggle: Boolean,
$url: String
) {
clientPortalConfigUpdate(
_id: $_id,
description: $description,
domain: $domain,
footerHtml: $footerHtml,
googleCredentials: $googleCredentials,
headerHtml: $headerHtml,
icon: $icon,
kbToggle: $kbToggle,
knowledgeBaseLabel: $knowledgeBaseLabel,
knowledgeBaseTopicId: $knowledgeBaseTopicId,
logo: $logo,
messengerBrandCode: $messengerBrandCode,
mobileResponsive: $mobileResponsive,
name: $name,
otpConfig: $otpConfig,
publicTaskToggle: $publicTaskToggle,
styles: $styles,
taskBoardId: $taskBoardId,
taskLabel: $taskLabel,
taskPipelineId: $taskPipelineId,
taskPublicBoardId: $taskPublicBoardId,
taskPublicPipelineId: $taskPublicPipelineId,
taskStageId: $taskStageId,
taskToggle: $taskToggle,
ticketBoardId: $ticketBoardId,
ticketLabel: $ticketLabel,
ticketPipelineId: $ticketPipelineId,
ticketStageId: $ticketStageId,
ticketToggle: $ticketToggle,
url: $url
) {
_id
description
dnsStatus
domain
footerHtml
googleCredentials
headerHtml
icon
kbToggle
knowledgeBaseLabel
knowledgeBaseTopicId
logo
messengerBrandCode
mobileResponsive
name
otpConfig {
codeLength
content
emailTransporterType
smsTransporterType
}
publicTaskToggle
styles {
activeTabColor
backgroundColor
baseColor
baseFont
bodyColor
dividerColor
footerColor
headerColor
headingColor
headingFont
helpColor
linkColor
linkHoverColor
primaryBtnColor
secondaryBtnColor
}
taskBoardId
taskLabel
taskPipelineId
taskPublicBoardId
taskPublicPipelineId
taskStageId
taskToggle
ticketBoardId
ticketLabel
ticketPipelineId
ticketStageId
ticketToggle
url
}
}
Variables
{
"_id": "xyz789",
"description": "xyz789",
"domain": "xyz789",
"footerHtml": "abc123",
"googleCredentials": {},
"headerHtml": "xyz789",
"icon": "abc123",
"kbToggle": true,
"knowledgeBaseLabel": "xyz789",
"knowledgeBaseTopicId": "abc123",
"logo": "abc123",
"messengerBrandCode": "abc123",
"mobileResponsive": true,
"name": "xyz789",
"otpConfig": OTPConfigInput,
"publicTaskToggle": true,
"styles": StylesParams,
"taskBoardId": "xyz789",
"taskLabel": "xyz789",
"taskPipelineId": "abc123",
"taskPublicBoardId": "abc123",
"taskPublicPipelineId": "abc123",
"taskStageId": "abc123",
"taskToggle": true,
"ticketBoardId": "xyz789",
"ticketLabel": "xyz789",
"ticketPipelineId": "xyz789",
"ticketStageId": "xyz789",
"ticketToggle": false,
"url": "xyz789"
}
Response
{
"data": {
"clientPortalConfigUpdate": {
"_id": "abc123",
"description": "xyz789",
"dnsStatus": "abc123",
"domain": "abc123",
"footerHtml": "abc123",
"googleCredentials": {},
"headerHtml": "xyz789",
"icon": "abc123",
"kbToggle": true,
"knowledgeBaseLabel": "xyz789",
"knowledgeBaseTopicId": "xyz789",
"logo": "abc123",
"messengerBrandCode": "abc123",
"mobileResponsive": false,
"name": "xyz789",
"otpConfig": OTPConfig,
"publicTaskToggle": false,
"styles": Styles,
"taskBoardId": "xyz789",
"taskLabel": "abc123",
"taskPipelineId": "xyz789",
"taskPublicBoardId": "abc123",
"taskPublicPipelineId": "abc123",
"taskStageId": "xyz789",
"taskToggle": true,
"ticketBoardId": "xyz789",
"ticketLabel": "xyz789",
"ticketPipelineId": "abc123",
"ticketStageId": "abc123",
"ticketToggle": false,
"url": "xyz789"
}
}
}
clientPortalConfirmInvitation
Response
Returns a
ClientPortalUser
Example
Query
mutation ClientPortalConfirmInvitation(
$password: String,
$passwordConfirmation: String,
$token: String,
$username: String
) {
clientPortalConfirmInvitation(
password: $password,
passwordConfirmation: $passwordConfirmation,
token: $token,
username: $username
) {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Variables
{
"password": "xyz789",
"passwordConfirmation": "xyz789",
"token": "xyz789",
"username": "abc123"
}
Response
{
"data": {
"clientPortalConfirmInvitation": {
"_id": "xyz789",
"clientPortalId": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "xyz789",
"erxesCustomerId": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "xyz789",
"password": "xyz789",
"phone": "xyz789",
"type": "xyz789",
"username": "abc123"
}
}
}
clientPortalCreateCard
Response
Returns a
Ticket
Example
Query
mutation ClientPortalCreateCard(
$description: String,
$email: String!,
$priority: String,
$stageId: String!,
$subject: String!,
$type: String!
) {
clientPortalCreateCard(
description: $description,
email: $email,
priority: $priority,
stageId: $stageId,
subject: $subject,
type: $type
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"description": "abc123",
"email": "xyz789",
"priority": "abc123",
"stageId": "abc123",
"subject": "xyz789",
"type": "abc123"
}
Response
{
"data": {
"clientPortalCreateCard": {
"_id": "xyz789",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": false,
"isComplete": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "xyz789",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 123,
"score": 987.65,
"source": "xyz789",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
clientPortalForgotPassword
Response
Returns a
String!
Example
Query
mutation ClientPortalForgotPassword(
$clientPortalId: String!,
$email: String,
$phone: String
) {
clientPortalForgotPassword(
clientPortalId: $clientPortalId,
email: $email,
phone: $phone
)
}
Variables
{
"clientPortalId": "xyz789",
"email": "xyz789",
"phone": "xyz789"
}
Response
{
"data": {
"clientPortalForgotPassword": "abc123"
}
}
clientPortalLogin
Response
Returns a
String
Example
Query
mutation ClientPortalLogin(
$clientPortalId: String!,
$deviceToken: String,
$login: String!,
$password: String!
) {
clientPortalLogin(
clientPortalId: $clientPortalId,
deviceToken: $deviceToken,
login: $login,
password: $password
)
}
Variables
{
"clientPortalId": "abc123",
"deviceToken": "abc123",
"login": "abc123",
"password": "xyz789"
}
Response
{"data": {"clientPortalLogin": "xyz789"}}
clientPortalLogout
Response
Returns a
String
Example
Query
mutation ClientPortalLogout {
clientPortalLogout
}
Response
{"data": {"clientPortalLogout": "abc123"}}
clientPortalRegister
Response
Returns a
String
Example
Query
mutation ClientPortalRegister(
$clientPortalId: String,
$code: String,
$customFieldsData: JSON,
$email: String,
$firstName: String,
$lastName: String,
$links: JSON,
$ownerId: String,
$password: String,
$phone: String,
$type: String,
$username: String
) {
clientPortalRegister(
clientPortalId: $clientPortalId,
code: $code,
customFieldsData: $customFieldsData,
email: $email,
firstName: $firstName,
lastName: $lastName,
links: $links,
ownerId: $ownerId,
password: $password,
phone: $phone,
type: $type,
username: $username
)
}
Variables
{
"clientPortalId": "xyz789",
"code": "xyz789",
"customFieldsData": {},
"email": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"links": {},
"ownerId": "xyz789",
"password": "abc123",
"phone": "abc123",
"type": "xyz789",
"username": "xyz789"
}
Response
{"data": {"clientPortalRegister": "abc123"}}
clientPortalRemove
clientPortalResetPassword
Example
Query
mutation ClientPortalResetPassword(
$newPassword: String!,
$token: String!
) {
clientPortalResetPassword(
newPassword: $newPassword,
token: $token
)
}
Variables
{
"newPassword": "abc123",
"token": "xyz789"
}
Response
{"data": {"clientPortalResetPassword": {}}}
clientPortalResetPasswordWithCode
Response
Returns a
String
Example
Query
mutation ClientPortalResetPasswordWithCode(
$code: String!,
$password: String!,
$phone: String!
) {
clientPortalResetPasswordWithCode(
code: $code,
password: $password,
phone: $phone
)
}
Variables
{
"code": "abc123",
"password": "xyz789",
"phone": "abc123"
}
Response
{
"data": {
"clientPortalResetPasswordWithCode": "xyz789"
}
}
clientPortalUserChangePassword
Response
Returns a
ClientPortalUser
Example
Query
mutation ClientPortalUserChangePassword(
$currentPassword: String!,
$newPassword: String!
) {
clientPortalUserChangePassword(
currentPassword: $currentPassword,
newPassword: $newPassword
) {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Variables
{
"currentPassword": "xyz789",
"newPassword": "xyz789"
}
Response
{
"data": {
"clientPortalUserChangePassword": {
"_id": "abc123",
"clientPortalId": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "xyz789",
"erxesCustomerId": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "xyz789",
"password": "abc123",
"phone": "xyz789",
"type": "abc123",
"username": "abc123"
}
}
}
clientPortalUsersEdit
Response
Returns a
ClientPortalUser
Example
Query
mutation ClientPortalUsersEdit(
$_id: String!,
$clientPortalId: String,
$code: String,
$customFieldsData: JSON,
$email: String,
$firstName: String,
$lastName: String,
$links: JSON,
$ownerId: String,
$password: String,
$phone: String,
$type: String,
$username: String
) {
clientPortalUsersEdit(
_id: $_id,
clientPortalId: $clientPortalId,
code: $code,
customFieldsData: $customFieldsData,
email: $email,
firstName: $firstName,
lastName: $lastName,
links: $links,
ownerId: $ownerId,
password: $password,
phone: $phone,
type: $type,
username: $username
) {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Variables
{
"_id": "xyz789",
"clientPortalId": "abc123",
"code": "xyz789",
"customFieldsData": {},
"email": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"links": {},
"ownerId": "xyz789",
"password": "abc123",
"phone": "xyz789",
"type": "abc123",
"username": "xyz789"
}
Response
{
"data": {
"clientPortalUsersEdit": {
"_id": "xyz789",
"clientPortalId": "abc123",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "xyz789",
"erxesCustomerId": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "abc123",
"password": "abc123",
"phone": "abc123",
"type": "abc123",
"username": "xyz789"
}
}
}
clientPortalUsersInvite
Response
Returns a
ClientPortalUser
Example
Query
mutation ClientPortalUsersInvite(
$clientPortalId: String,
$code: String,
$customFieldsData: JSON,
$email: String,
$firstName: String,
$lastName: String,
$links: JSON,
$ownerId: String,
$password: String,
$phone: String,
$type: String,
$username: String
) {
clientPortalUsersInvite(
clientPortalId: $clientPortalId,
code: $code,
customFieldsData: $customFieldsData,
email: $email,
firstName: $firstName,
lastName: $lastName,
links: $links,
ownerId: $ownerId,
password: $password,
phone: $phone,
type: $type,
username: $username
) {
_id
clientPortalId
code
createdAt
customFieldsData
email
erxesCustomerId
firstName
lastName
links
modifiedAt
ownerId
password
phone
type
username
}
}
Variables
{
"clientPortalId": "abc123",
"code": "xyz789",
"customFieldsData": {},
"email": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"links": {},
"ownerId": "xyz789",
"password": "xyz789",
"phone": "xyz789",
"type": "xyz789",
"username": "xyz789"
}
Response
{
"data": {
"clientPortalUsersInvite": {
"_id": "xyz789",
"clientPortalId": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "abc123",
"erxesCustomerId": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "xyz789",
"password": "xyz789",
"phone": "xyz789",
"type": "xyz789",
"username": "xyz789"
}
}
}
clientPortalUsersRemove
Example
Query
mutation ClientPortalUsersRemove($clientPortalUserIds: [String!]) {
clientPortalUsersRemove(clientPortalUserIds: $clientPortalUserIds)
}
Variables
{"clientPortalUserIds": ["xyz789"]}
Response
{"data": {"clientPortalUsersRemove": {}}}
clientPortalVerifyOTP
Response
Returns a
String
Example
Query
mutation ClientPortalVerifyOTP(
$emailOtp: String,
$password: String,
$phoneOtp: String,
$userId: String!
) {
clientPortalVerifyOTP(
emailOtp: $emailOtp,
password: $password,
phoneOtp: $phoneOtp,
userId: $userId
)
}
Variables
{
"emailOtp": "xyz789",
"password": "abc123",
"phoneOtp": "abc123",
"userId": "abc123"
}
Response
{
"data": {
"clientPortalVerifyOTP": "xyz789"
}
}
commentAdd
Response
Returns a
Comment
Arguments
| Name | Description |
|---|---|
comment -
String!
|
|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
parentId -
String
|
Example
Query
mutation CommentAdd(
$comment: String!,
$contentId: String!,
$contentType: ReactionContentType!,
$parentId: String
) {
commentAdd(
comment: $comment,
contentId: $contentId,
contentType: $contentType,
parentId: $parentId
) {
_id
childCount
comment
contentId
contentType
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
parentId
updatedAt
}
}
Variables
{
"comment": "xyz789",
"contentId": "abc123",
"contentType": "exmFeed",
"parentId": "abc123"
}
Response
{
"data": {
"commentAdd": {
"_id": "xyz789",
"childCount": 123,
"comment": "xyz789",
"contentId": "abc123",
"contentType": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"parentId": "abc123",
"updatedAt": "2007-12-03"
}
}
}
commentEdit
Response
Returns a
Comment
Arguments
| Name | Description |
|---|---|
_id -
String
|
|
comment -
String!
|
|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
parentId -
String
|
Example
Query
mutation CommentEdit(
$_id: String,
$comment: String!,
$contentId: String!,
$contentType: ReactionContentType!,
$parentId: String
) {
commentEdit(
_id: $_id,
comment: $comment,
contentId: $contentId,
contentType: $contentType,
parentId: $parentId
) {
_id
childCount
comment
contentId
contentType
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
parentId
updatedAt
}
}
Variables
{
"_id": "xyz789",
"comment": "xyz789",
"contentId": "abc123",
"contentType": "exmFeed",
"parentId": "abc123"
}
Response
{
"data": {
"commentEdit": {
"_id": "abc123",
"childCount": 123,
"comment": "abc123",
"contentId": "xyz789",
"contentType": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"parentId": "abc123",
"updatedAt": "2007-12-03"
}
}
}
commentRemove
companiesAdd
Response
Returns a
Company
Arguments
| Name | Description |
|---|---|
avatar -
String
|
|
businessType -
String
|
|
code -
String
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
email -
String
|
|
emails -
[String]
|
|
industry -
String
|
|
isSubscribed -
String
|
|
links -
JSON
|
|
location -
String
|
|
names -
[String]
|
|
ownerId -
String
|
|
parentCompanyId -
String
|
|
phones -
[String]
|
|
primaryEmail -
String
|
|
primaryName -
String
|
|
primaryPhone -
String
|
|
size -
Int
|
|
tagIds -
[String]
|
|
website -
String
|
Example
Query
mutation CompaniesAdd(
$avatar: String,
$businessType: String,
$code: String,
$customFieldsData: JSON,
$description: String,
$email: String,
$emails: [String],
$industry: String,
$isSubscribed: String,
$links: JSON,
$location: String,
$names: [String],
$ownerId: String,
$parentCompanyId: String,
$phones: [String],
$primaryEmail: String,
$primaryName: String,
$primaryPhone: String,
$size: Int,
$tagIds: [String],
$website: String
) {
companiesAdd(
avatar: $avatar,
businessType: $businessType,
code: $code,
customFieldsData: $customFieldsData,
description: $description,
email: $email,
emails: $emails,
industry: $industry,
isSubscribed: $isSubscribed,
links: $links,
location: $location,
names: $names,
ownerId: $ownerId,
parentCompanyId: $parentCompanyId,
phones: $phones,
primaryEmail: $primaryEmail,
primaryName: $primaryName,
primaryPhone: $primaryPhone,
size: $size,
tagIds: $tagIds,
website: $website
) {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
emails
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
parentCompany {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
}
Variables
{
"avatar": "abc123",
"businessType": "abc123",
"code": "xyz789",
"customFieldsData": {},
"description": "abc123",
"email": "abc123",
"emails": ["xyz789"],
"industry": "xyz789",
"isSubscribed": "xyz789",
"links": {},
"location": "abc123",
"names": ["xyz789"],
"ownerId": "xyz789",
"parentCompanyId": "abc123",
"phones": ["abc123"],
"primaryEmail": "xyz789",
"primaryName": "abc123",
"primaryPhone": "abc123",
"size": 123,
"tagIds": ["xyz789"],
"website": "xyz789"
}
Response
{
"data": {
"companiesAdd": {
"_id": "xyz789",
"avatar": "abc123",
"businessType": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"emails": ["abc123"],
"getTags": [Tag],
"industry": "abc123",
"isSubscribed": "xyz789",
"links": {},
"location": "abc123",
"mergedIds": ["abc123"],
"modifiedAt": "2007-12-03",
"names": ["abc123"],
"owner": User,
"ownerId": "xyz789",
"parentCompany": Company,
"parentCompanyId": "abc123",
"phones": ["abc123"],
"plan": "abc123",
"primaryEmail": "abc123",
"primaryName": "xyz789",
"primaryPhone": "abc123",
"score": 987.65,
"size": 987,
"tagIds": ["xyz789"],
"trackedData": {},
"website": "xyz789"
}
}
}
companiesEdit
Response
Returns a
Company
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
avatar -
String
|
|
businessType -
String
|
|
code -
String
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
email -
String
|
|
emails -
[String]
|
|
industry -
String
|
|
isSubscribed -
String
|
|
links -
JSON
|
|
location -
String
|
|
names -
[String]
|
|
ownerId -
String
|
|
parentCompanyId -
String
|
|
phones -
[String]
|
|
primaryEmail -
String
|
|
primaryName -
String
|
|
primaryPhone -
String
|
|
size -
Int
|
|
tagIds -
[String]
|
|
website -
String
|
Example
Query
mutation CompaniesEdit(
$_id: String!,
$avatar: String,
$businessType: String,
$code: String,
$customFieldsData: JSON,
$description: String,
$email: String,
$emails: [String],
$industry: String,
$isSubscribed: String,
$links: JSON,
$location: String,
$names: [String],
$ownerId: String,
$parentCompanyId: String,
$phones: [String],
$primaryEmail: String,
$primaryName: String,
$primaryPhone: String,
$size: Int,
$tagIds: [String],
$website: String
) {
companiesEdit(
_id: $_id,
avatar: $avatar,
businessType: $businessType,
code: $code,
customFieldsData: $customFieldsData,
description: $description,
email: $email,
emails: $emails,
industry: $industry,
isSubscribed: $isSubscribed,
links: $links,
location: $location,
names: $names,
ownerId: $ownerId,
parentCompanyId: $parentCompanyId,
phones: $phones,
primaryEmail: $primaryEmail,
primaryName: $primaryName,
primaryPhone: $primaryPhone,
size: $size,
tagIds: $tagIds,
website: $website
) {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
emails
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
parentCompany {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
}
Variables
{
"_id": "xyz789",
"avatar": "abc123",
"businessType": "abc123",
"code": "abc123",
"customFieldsData": {},
"description": "xyz789",
"email": "xyz789",
"emails": ["xyz789"],
"industry": "xyz789",
"isSubscribed": "xyz789",
"links": {},
"location": "abc123",
"names": ["xyz789"],
"ownerId": "xyz789",
"parentCompanyId": "abc123",
"phones": ["xyz789"],
"primaryEmail": "abc123",
"primaryName": "abc123",
"primaryPhone": "xyz789",
"size": 987,
"tagIds": ["xyz789"],
"website": "xyz789"
}
Response
{
"data": {
"companiesEdit": {
"_id": "xyz789",
"avatar": "abc123",
"businessType": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"emails": ["abc123"],
"getTags": [Tag],
"industry": "abc123",
"isSubscribed": "abc123",
"links": {},
"location": "abc123",
"mergedIds": ["xyz789"],
"modifiedAt": "2007-12-03",
"names": ["xyz789"],
"owner": User,
"ownerId": "xyz789",
"parentCompany": Company,
"parentCompanyId": "xyz789",
"phones": ["xyz789"],
"plan": "xyz789",
"primaryEmail": "abc123",
"primaryName": "xyz789",
"primaryPhone": "abc123",
"score": 987.65,
"size": 987,
"tagIds": ["xyz789"],
"trackedData": {},
"website": "xyz789"
}
}
}
companiesEditByField
Example
Query
mutation CompaniesEditByField(
$doc: JSON,
$selector: JSON
) {
companiesEditByField(
doc: $doc,
selector: $selector
) {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
emails
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
parentCompany {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
}
Variables
{"doc": {}, "selector": {}}
Response
{
"data": {
"companiesEditByField": {
"_id": "abc123",
"avatar": "abc123",
"businessType": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"emails": ["xyz789"],
"getTags": [Tag],
"industry": "xyz789",
"isSubscribed": "xyz789",
"links": {},
"location": "xyz789",
"mergedIds": ["abc123"],
"modifiedAt": "2007-12-03",
"names": ["abc123"],
"owner": User,
"ownerId": "xyz789",
"parentCompany": Company,
"parentCompanyId": "xyz789",
"phones": ["abc123"],
"plan": "xyz789",
"primaryEmail": "abc123",
"primaryName": "xyz789",
"primaryPhone": "abc123",
"score": 123.45,
"size": 123,
"tagIds": ["xyz789"],
"trackedData": {},
"website": "abc123"
}
}
}
companiesMerge
Example
Query
mutation CompaniesMerge(
$companyFields: JSON,
$companyIds: [String]
) {
companiesMerge(
companyFields: $companyFields,
companyIds: $companyIds
) {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
emails
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
parentCompany {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
}
Variables
{
"companyFields": {},
"companyIds": ["xyz789"]
}
Response
{
"data": {
"companiesMerge": {
"_id": "xyz789",
"avatar": "xyz789",
"businessType": "abc123",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"emails": ["abc123"],
"getTags": [Tag],
"industry": "abc123",
"isSubscribed": "xyz789",
"links": {},
"location": "xyz789",
"mergedIds": ["xyz789"],
"modifiedAt": "2007-12-03",
"names": ["abc123"],
"owner": User,
"ownerId": "abc123",
"parentCompany": Company,
"parentCompanyId": "abc123",
"phones": ["xyz789"],
"plan": "xyz789",
"primaryEmail": "xyz789",
"primaryName": "abc123",
"primaryPhone": "xyz789",
"score": 123.45,
"size": 123,
"tagIds": ["abc123"],
"trackedData": {},
"website": "abc123"
}
}
}
companiesRemove
configsActivateInstallation
Example
Query
mutation ConfigsActivateInstallation(
$hostname: String!,
$token: String!
) {
configsActivateInstallation(
hostname: $hostname,
token: $token
)
}
Variables
{
"hostname": "abc123",
"token": "xyz789"
}
Response
{"data": {"configsActivateInstallation": {}}}
configsManagePluginInstall
Example
Query
mutation ConfigsManagePluginInstall(
$name: String!,
$type: String!
) {
configsManagePluginInstall(
name: $name,
type: $type
)
}
Variables
{
"name": "xyz789",
"type": "xyz789"
}
Response
{"data": {"configsManagePluginInstall": {}}}
configsUpdate
confirmLoyalties
conformityAdd
Response
Returns a
Conformity
Example
Query
mutation ConformityAdd(
$mainType: String,
$mainTypeId: String,
$relType: String,
$relTypeId: String
) {
conformityAdd(
mainType: $mainType,
mainTypeId: $mainTypeId,
relType: $relType,
relTypeId: $relTypeId
) {
_id
mainType
mainTypeId
relType
relTypeId
}
}
Variables
{
"mainType": "xyz789",
"mainTypeId": "xyz789",
"relType": "xyz789",
"relTypeId": "xyz789"
}
Response
{
"data": {
"conformityAdd": {
"_id": "abc123",
"mainType": "abc123",
"mainTypeId": "xyz789",
"relType": "abc123",
"relTypeId": "xyz789"
}
}
}
conformityEdit
Response
Returns a
SuccessResult
Example
Query
mutation ConformityEdit(
$mainType: String,
$mainTypeId: String,
$relType: String,
$relTypeIds: [String]
) {
conformityEdit(
mainType: $mainType,
mainTypeId: $mainTypeId,
relType: $relType,
relTypeIds: $relTypeIds
) {
success
}
}
Variables
{
"mainType": "abc123",
"mainTypeId": "xyz789",
"relType": "abc123",
"relTypeIds": ["abc123"]
}
Response
{"data": {"conformityEdit": {"success": false}}}
conversationConvertToCard
Response
Returns a
String
Example
Query
mutation ConversationConvertToCard(
$_id: String!,
$bookingProductId: String,
$itemId: String,
$itemName: String,
$stageId: String,
$type: String!
) {
conversationConvertToCard(
_id: $_id,
bookingProductId: $bookingProductId,
itemId: $itemId,
itemName: $itemName,
stageId: $stageId,
type: $type
)
}
Variables
{
"_id": "xyz789",
"bookingProductId": "abc123",
"itemId": "xyz789",
"itemName": "xyz789",
"stageId": "xyz789",
"type": "abc123"
}
Response
{
"data": {
"conversationConvertToCard": "abc123"
}
}
conversationCreateVideoChatRoom
Response
Returns a
VideoCallData
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation ConversationCreateVideoChatRoom($_id: String!) {
conversationCreateVideoChatRoom(_id: $_id) {
name
recordingLinks
status
url
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"conversationCreateVideoChatRoom": {
"name": "xyz789",
"recordingLinks": ["abc123"],
"status": "abc123",
"url": "xyz789"
}
}
}
conversationEditCustomFields
Response
Returns a
Conversation
Example
Query
mutation ConversationEditCustomFields(
$_id: String!,
$customFieldsData: JSON
) {
conversationEditCustomFields(
_id: $_id,
customFieldsData: $customFieldsData
) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{"_id": "xyz789", "customFieldsData": {}}
Response
{
"data": {
"conversationEditCustomFields": {
"_id": "xyz789",
"assignedUser": User,
"assignedUserId": "abc123",
"bookingProductId": "abc123",
"callProAudio": "xyz789",
"content": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "xyz789",
"facebookPost": FacebookPost,
"idleTime": 123.45,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": true,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 123,
"operatorStatus": "abc123",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 987,
"readUserIds": ["abc123"],
"status": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
conversationMarkAsRead
Response
Returns a
Conversation
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
mutation ConversationMarkAsRead($_id: String) {
conversationMarkAsRead(_id: $_id) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"conversationMarkAsRead": {
"_id": "abc123",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "xyz789",
"callProAudio": "abc123",
"content": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"facebookPost": FacebookPost,
"idleTime": 987.65,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": false,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 987,
"operatorStatus": "abc123",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 123,
"readUserIds": ["xyz789"],
"status": "abc123",
"tagIds": ["abc123"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "xyz789",
"videoCallData": VideoCallData
}
}
}
conversationMessageAdd
Response
Returns a
ConversationMessage
Example
Query
mutation ConversationMessageAdd(
$attachments: [AttachmentInput],
$content: String,
$contentType: String,
$conversationId: String,
$facebookMessageTag: String,
$internal: Boolean,
$mentionedUserIds: [String]
) {
conversationMessageAdd(
attachments: $attachments,
content: $content,
contentType: $contentType,
conversationId: $conversationId,
facebookMessageTag: $facebookMessageTag,
internal: $internal,
mentionedUserIds: $mentionedUserIds
) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"attachments": [AttachmentInput],
"content": "xyz789",
"contentType": "abc123",
"conversationId": "xyz789",
"facebookMessageTag": "xyz789",
"internal": true,
"mentionedUserIds": ["abc123"]
}
Response
{
"data": {
"conversationMessageAdd": {
"_id": "abc123",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "xyz789",
"contentType": "xyz789",
"conversationId": "abc123",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "xyz789",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": false,
"internal": false,
"isCustomerRead": true,
"mailData": MailData,
"mentionedUserIds": ["xyz789"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
conversationResolveAll
Response
Returns an
Int
Example
Query
mutation ConversationResolveAll(
$awaitingResponse: String,
$brandId: String,
$channelId: String,
$endDate: String,
$integrationType: String,
$participating: String,
$segment: String,
$starred: String,
$startDate: String,
$status: String,
$tag: String,
$unassigned: String
) {
conversationResolveAll(
awaitingResponse: $awaitingResponse,
brandId: $brandId,
channelId: $channelId,
endDate: $endDate,
integrationType: $integrationType,
participating: $participating,
segment: $segment,
starred: $starred,
startDate: $startDate,
status: $status,
tag: $tag,
unassigned: $unassigned
)
}
Variables
{
"awaitingResponse": "xyz789",
"brandId": "xyz789",
"channelId": "xyz789",
"endDate": "xyz789",
"integrationType": "abc123",
"participating": "abc123",
"segment": "xyz789",
"starred": "abc123",
"startDate": "xyz789",
"status": "abc123",
"tag": "abc123",
"unassigned": "xyz789"
}
Response
{"data": {"conversationResolveAll": 123}}
conversationsAssign
Response
Returns
[Conversation]
Example
Query
mutation ConversationsAssign(
$assignedUserId: String,
$conversationIds: [String]!
) {
conversationsAssign(
assignedUserId: $assignedUserId,
conversationIds: $conversationIds
) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"assignedUserId": "xyz789",
"conversationIds": ["xyz789"]
}
Response
{
"data": {
"conversationsAssign": [
{
"_id": "abc123",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "xyz789",
"callProAudio": "xyz789",
"content": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"facebookPost": FacebookPost,
"idleTime": 123.45,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": true,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 123,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 123,
"readUserIds": ["xyz789"],
"status": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
]
}
}
conversationsChangeStatus
Response
Returns
[Conversation]
Example
Query
mutation ConversationsChangeStatus(
$_ids: [String]!,
$status: String!
) {
conversationsChangeStatus(
_ids: $_ids,
status: $status
) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"_ids": ["xyz789"],
"status": "xyz789"
}
Response
{
"data": {
"conversationsChangeStatus": [
{
"_id": "abc123",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "xyz789",
"callProAudio": "abc123",
"content": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"facebookPost": FacebookPost,
"idleTime": 987.65,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": false,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 123,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 123,
"readUserIds": ["xyz789"],
"status": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
]
}
}
conversationsChangeStatusFacebookComment
Response
Returns a
FacebookComment
Arguments
| Name | Description |
|---|---|
commentId -
String
|
Example
Query
mutation ConversationsChangeStatusFacebookComment($commentId: String) {
conversationsChangeStatusFacebookComment(commentId: $commentId) {
attachments
commentCount
commentId
content
conversationId
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
erxesApiId
isResolved
parentId
permalink_url
postId
recipientId
senderId
timestamp
}
}
Variables
{"commentId": "xyz789"}
Response
{
"data": {
"conversationsChangeStatusFacebookComment": {
"attachments": ["xyz789"],
"commentCount": 987,
"commentId": "xyz789",
"content": "abc123",
"conversationId": "xyz789",
"customer": Customer,
"erxesApiId": "abc123",
"isResolved": true,
"parentId": "xyz789",
"permalink_url": "xyz789",
"postId": "abc123",
"recipientId": "xyz789",
"senderId": "abc123",
"timestamp": "2007-12-03"
}
}
}
conversationsReplyFacebookComment
Response
Returns a
FacebookComment
Example
Query
mutation ConversationsReplyFacebookComment(
$commentId: String,
$content: String,
$conversationId: String
) {
conversationsReplyFacebookComment(
commentId: $commentId,
content: $content,
conversationId: $conversationId
) {
attachments
commentCount
commentId
content
conversationId
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
erxesApiId
isResolved
parentId
permalink_url
postId
recipientId
senderId
timestamp
}
}
Variables
{
"commentId": "xyz789",
"content": "xyz789",
"conversationId": "abc123"
}
Response
{
"data": {
"conversationsReplyFacebookComment": {
"attachments": ["xyz789"],
"commentCount": 123,
"commentId": "xyz789",
"content": "abc123",
"conversationId": "xyz789",
"customer": Customer,
"erxesApiId": "abc123",
"isResolved": true,
"parentId": "xyz789",
"permalink_url": "xyz789",
"postId": "xyz789",
"recipientId": "abc123",
"senderId": "xyz789",
"timestamp": "2007-12-03"
}
}
}
conversationsUnassign
Response
Returns
[Conversation]
Arguments
| Name | Description |
|---|---|
_ids -
[String]!
|
Example
Query
mutation ConversationsUnassign($_ids: [String]!) {
conversationsUnassign(_ids: $_ids) {
_id
assignedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
facebookPost {
attachments
content
erxesApiId
permalink_url
postId
recipientId
senderId
timestamp
}
idleTime
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
_id
attachments {
...AttachmentFragment
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
...CustomerFragment
}
customerId
engageData {
...EngageDataFragment
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
...MailDataFragment
}
mentionedUserIds
messengerAppData
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
number
operatorStatus
participatedUserIds
participatedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
participatorCount
readUserIds
status
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
updatedAt
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{"_ids": ["xyz789"]}
Response
{
"data": {
"conversationsUnassign": [
{
"_id": "xyz789",
"assignedUser": User,
"assignedUserId": "xyz789",
"bookingProductId": "xyz789",
"callProAudio": "abc123",
"content": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"facebookPost": FacebookPost,
"idleTime": 987.65,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": false,
"messageCount": 987,
"messages": [ConversationMessage],
"number": 987,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 123,
"readUserIds": ["xyz789"],
"status": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
]
}
}
cpDonatesAdd
Response
Returns a
Donate
Example
Query
mutation CpDonatesAdd(
$campaignId: String,
$donateScore: Float,
$ownerId: String,
$ownerType: String,
$usedAt: Date
) {
cpDonatesAdd(
campaignId: $campaignId,
donateScore: $donateScore,
ownerId: $ownerId,
ownerType: $ownerType,
usedAt: $usedAt
) {
_id
awardId
campaign
campaignId
createdAt
donateScore
owner
ownerId
ownerType
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "xyz789",
"donateScore": 123.45,
"ownerId": "xyz789",
"ownerType": "abc123",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"cpDonatesAdd": {
"_id": "xyz789",
"awardId": "xyz789",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"donateScore": 987.65,
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
}
}
cpDonatesRemove
createSkill
Response
Returns a
JSON
Example
Query
mutation CreateSkill(
$memberIds: [String],
$name: String!,
$typeId: String!
) {
createSkill(
memberIds: $memberIds,
name: $name,
typeId: $typeId
)
}
Variables
{
"memberIds": ["xyz789"],
"name": "abc123",
"typeId": "abc123"
}
Response
{"data": {"createSkill": {}}}
createSkillType
customersAdd
Response
Returns a
Customer
Arguments
| Name | Description |
|---|---|
avatar -
String
|
|
birthDate -
Date
|
|
code -
String
|
|
customFieldsData -
JSON
|
|
department -
String
|
|
description -
String
|
|
emailValidationStatus -
String
|
|
emails -
[String]
|
|
firstName -
String
|
|
hasAuthority -
String
|
|
isSubscribed -
String
|
|
lastName -
String
|
|
leadStatus -
String
|
|
links -
JSON
|
|
middleName -
String
|
|
ownerId -
String
|
|
phoneValidationStatus -
String
|
|
phones -
[String]
|
|
position -
String
|
|
primaryEmail -
String
|
|
primaryPhone -
String
|
|
sex -
Int
|
|
state -
String
|
Example
Query
mutation CustomersAdd(
$avatar: String,
$birthDate: Date,
$code: String,
$customFieldsData: JSON,
$department: String,
$description: String,
$emailValidationStatus: String,
$emails: [String],
$firstName: String,
$hasAuthority: String,
$isSubscribed: String,
$lastName: String,
$leadStatus: String,
$links: JSON,
$middleName: String,
$ownerId: String,
$phoneValidationStatus: String,
$phones: [String],
$position: String,
$primaryEmail: String,
$primaryPhone: String,
$sex: Int,
$state: String
) {
customersAdd(
avatar: $avatar,
birthDate: $birthDate,
code: $code,
customFieldsData: $customFieldsData,
department: $department,
description: $description,
emailValidationStatus: $emailValidationStatus,
emails: $emails,
firstName: $firstName,
hasAuthority: $hasAuthority,
isSubscribed: $isSubscribed,
lastName: $lastName,
leadStatus: $leadStatus,
links: $links,
middleName: $middleName,
ownerId: $ownerId,
phoneValidationStatus: $phoneValidationStatus,
phones: $phones,
position: $position,
primaryEmail: $primaryEmail,
primaryPhone: $primaryPhone,
sex: $sex,
state: $state
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{
"avatar": "abc123",
"birthDate": "2007-12-03",
"code": "xyz789",
"customFieldsData": {},
"department": "abc123",
"description": "abc123",
"emailValidationStatus": "abc123",
"emails": ["abc123"],
"firstName": "abc123",
"hasAuthority": "abc123",
"isSubscribed": "xyz789",
"lastName": "abc123",
"leadStatus": "abc123",
"links": {},
"middleName": "abc123",
"ownerId": "xyz789",
"phoneValidationStatus": "xyz789",
"phones": ["xyz789"],
"position": "xyz789",
"primaryEmail": "abc123",
"primaryPhone": "abc123",
"sex": 123,
"state": "abc123"
}
Response
{
"data": {
"customersAdd": {
"_id": "xyz789",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "abc123",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "abc123",
"email": "abc123",
"emailValidationStatus": "xyz789",
"emails": ["xyz789"],
"firstName": "abc123",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "abc123",
"isOnline": true,
"isSubscribed": "xyz789",
"lastName": "xyz789",
"lastSeenAt": "2007-12-03",
"leadStatus": "xyz789",
"links": {},
"location": {},
"middleName": "xyz789",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "xyz789",
"phone": "xyz789",
"phoneValidationStatus": "xyz789",
"phones": ["xyz789"],
"position": "abc123",
"primaryEmail": "abc123",
"primaryPhone": "abc123",
"remoteAddress": "abc123",
"score": 987.65,
"sessionCount": 123,
"sex": 987,
"state": "abc123",
"tagIds": ["abc123"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
}
}
customersChangeState
Example
Query
mutation CustomersChangeState(
$_id: String!,
$value: String!
) {
customersChangeState(
_id: $_id,
value: $value
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{
"_id": "abc123",
"value": "xyz789"
}
Response
{
"data": {
"customersChangeState": {
"_id": "abc123",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "xyz789",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "abc123",
"email": "xyz789",
"emailValidationStatus": "abc123",
"emails": ["xyz789"],
"firstName": "abc123",
"getTags": [Tag],
"hasAuthority": "abc123",
"integration": Integration,
"integrationId": "abc123",
"isOnline": true,
"isSubscribed": "abc123",
"lastName": "abc123",
"lastSeenAt": "2007-12-03",
"leadStatus": "xyz789",
"links": {},
"location": {},
"middleName": "abc123",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "abc123",
"phone": "abc123",
"phoneValidationStatus": "xyz789",
"phones": ["abc123"],
"position": "abc123",
"primaryEmail": "xyz789",
"primaryPhone": "abc123",
"remoteAddress": "abc123",
"score": 123.45,
"sessionCount": 987,
"sex": 987,
"state": "abc123",
"tagIds": ["xyz789"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
}
}
customersChangeVerificationStatus
Response
Returns
[Customer]
Example
Query
mutation CustomersChangeVerificationStatus(
$customerIds: [String],
$status: String!,
$type: String!
) {
customersChangeVerificationStatus(
customerIds: $customerIds,
status: $status,
type: $type
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{
"customerIds": ["xyz789"],
"status": "xyz789",
"type": "xyz789"
}
Response
{
"data": {
"customersChangeVerificationStatus": [
{
"_id": "abc123",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "xyz789",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "abc123",
"email": "xyz789",
"emailValidationStatus": "abc123",
"emails": ["xyz789"],
"firstName": "xyz789",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "abc123",
"isOnline": false,
"isSubscribed": "abc123",
"lastName": "abc123",
"lastSeenAt": "2007-12-03",
"leadStatus": "abc123",
"links": {},
"location": {},
"middleName": "xyz789",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "abc123",
"phone": "abc123",
"phoneValidationStatus": "xyz789",
"phones": ["abc123"],
"position": "abc123",
"primaryEmail": "abc123",
"primaryPhone": "xyz789",
"remoteAddress": "xyz789",
"score": 987.65,
"sessionCount": 987,
"sex": 123,
"state": "abc123",
"tagIds": ["xyz789"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
]
}
}
customersEdit
Response
Returns a
Customer
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
avatar -
String
|
|
birthDate -
Date
|
|
code -
String
|
|
customFieldsData -
JSON
|
|
department -
String
|
|
description -
String
|
|
emailValidationStatus -
String
|
|
emails -
[String]
|
|
firstName -
String
|
|
hasAuthority -
String
|
|
isSubscribed -
String
|
|
lastName -
String
|
|
leadStatus -
String
|
|
links -
JSON
|
|
middleName -
String
|
|
ownerId -
String
|
|
phoneValidationStatus -
String
|
|
phones -
[String]
|
|
position -
String
|
|
primaryEmail -
String
|
|
primaryPhone -
String
|
|
sex -
Int
|
Example
Query
mutation CustomersEdit(
$_id: String!,
$avatar: String,
$birthDate: Date,
$code: String,
$customFieldsData: JSON,
$department: String,
$description: String,
$emailValidationStatus: String,
$emails: [String],
$firstName: String,
$hasAuthority: String,
$isSubscribed: String,
$lastName: String,
$leadStatus: String,
$links: JSON,
$middleName: String,
$ownerId: String,
$phoneValidationStatus: String,
$phones: [String],
$position: String,
$primaryEmail: String,
$primaryPhone: String,
$sex: Int
) {
customersEdit(
_id: $_id,
avatar: $avatar,
birthDate: $birthDate,
code: $code,
customFieldsData: $customFieldsData,
department: $department,
description: $description,
emailValidationStatus: $emailValidationStatus,
emails: $emails,
firstName: $firstName,
hasAuthority: $hasAuthority,
isSubscribed: $isSubscribed,
lastName: $lastName,
leadStatus: $leadStatus,
links: $links,
middleName: $middleName,
ownerId: $ownerId,
phoneValidationStatus: $phoneValidationStatus,
phones: $phones,
position: $position,
primaryEmail: $primaryEmail,
primaryPhone: $primaryPhone,
sex: $sex
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{
"_id": "xyz789",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "abc123",
"customFieldsData": {},
"department": "xyz789",
"description": "xyz789",
"emailValidationStatus": "abc123",
"emails": ["abc123"],
"firstName": "xyz789",
"hasAuthority": "abc123",
"isSubscribed": "abc123",
"lastName": "abc123",
"leadStatus": "xyz789",
"links": {},
"middleName": "abc123",
"ownerId": "xyz789",
"phoneValidationStatus": "abc123",
"phones": ["xyz789"],
"position": "xyz789",
"primaryEmail": "xyz789",
"primaryPhone": "abc123",
"sex": 987
}
Response
{
"data": {
"customersEdit": {
"_id": "abc123",
"avatar": "abc123",
"birthDate": "2007-12-03",
"code": "abc123",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "xyz789",
"email": "abc123",
"emailValidationStatus": "xyz789",
"emails": ["abc123"],
"firstName": "abc123",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "abc123",
"isOnline": true,
"isSubscribed": "xyz789",
"lastName": "abc123",
"lastSeenAt": "2007-12-03",
"leadStatus": "abc123",
"links": {},
"location": {},
"middleName": "abc123",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "xyz789",
"phone": "abc123",
"phoneValidationStatus": "abc123",
"phones": ["xyz789"],
"position": "abc123",
"primaryEmail": "xyz789",
"primaryPhone": "abc123",
"remoteAddress": "abc123",
"score": 123.45,
"sessionCount": 987,
"sex": 987,
"state": "abc123",
"tagIds": ["abc123"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
}
}
customersEditByField
Example
Query
mutation CustomersEditByField(
$doc: JSON,
$selector: JSON
) {
customersEditByField(
doc: $doc,
selector: $selector
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{"doc": {}, "selector": {}}
Response
{
"data": {
"customersEditByField": {
"_id": "abc123",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "abc123",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "xyz789",
"email": "xyz789",
"emailValidationStatus": "abc123",
"emails": ["xyz789"],
"firstName": "xyz789",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "abc123",
"isOnline": false,
"isSubscribed": "abc123",
"lastName": "xyz789",
"lastSeenAt": "2007-12-03",
"leadStatus": "abc123",
"links": {},
"location": {},
"middleName": "xyz789",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "abc123",
"phone": "abc123",
"phoneValidationStatus": "xyz789",
"phones": ["xyz789"],
"position": "abc123",
"primaryEmail": "xyz789",
"primaryPhone": "xyz789",
"remoteAddress": "xyz789",
"score": 123.45,
"sessionCount": 987,
"sex": 123,
"state": "abc123",
"tagIds": ["abc123"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
}
}
customersMerge
Example
Query
mutation CustomersMerge(
$customerFields: JSON,
$customerIds: [String]
) {
customersMerge(
customerFields: $customerFields,
customerIds: $customerIds
) {
_id
avatar
birthDate
code
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
conversations {
_id
assignedUser {
...UserFragment
}
assignedUserId
bookingProductId
callProAudio
content
createdAt
customFieldsData
customer {
...CustomerFragment
}
customerId
facebookPost {
...FacebookPostFragment
}
idleTime
integration {
...IntegrationFragment
}
integrationId
isFacebookTaggedMessage
messageCount
messages {
...ConversationMessageFragment
}
number
operatorStatus
participatedUserIds
participatedUsers {
...UserFragment
}
participatorCount
readUserIds
status
tagIds
tags {
...TagFragment
}
updatedAt
user {
...UserFragment
}
userId
videoCallData {
...VideoCallDataFragment
}
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
hasAuthority
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
}
Variables
{
"customerFields": {},
"customerIds": ["xyz789"]
}
Response
{
"data": {
"customersMerge": {
"_id": "abc123",
"avatar": "abc123",
"birthDate": "2007-12-03",
"code": "xyz789",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "abc123",
"description": "abc123",
"email": "abc123",
"emailValidationStatus": "xyz789",
"emails": ["xyz789"],
"firstName": "abc123",
"getTags": [Tag],
"hasAuthority": "xyz789",
"integration": Integration,
"integrationId": "abc123",
"isOnline": true,
"isSubscribed": "abc123",
"lastName": "abc123",
"lastSeenAt": "2007-12-03",
"leadStatus": "xyz789",
"links": {},
"location": {},
"middleName": "xyz789",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "xyz789",
"phone": "xyz789",
"phoneValidationStatus": "abc123",
"phones": ["xyz789"],
"position": "xyz789",
"primaryEmail": "xyz789",
"primaryPhone": "xyz789",
"remoteAddress": "xyz789",
"score": 987.65,
"sessionCount": 123,
"sex": 987,
"state": "abc123",
"tagIds": ["abc123"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
}
}
customersRemove
customersVerify
dashboardAdd
Response
Returns a
Dashboard
Example
Query
mutation DashboardAdd(
$description: String,
$name: String,
$parentId: String,
$selectedMemberIds: [String],
$visibility: String
) {
dashboardAdd(
description: $description,
name: $name,
parentId: $parentId,
selectedMemberIds: $selectedMemberIds,
visibility: $visibility
) {
_id
childsDashboard {
_id
childsDashboard {
...DashboardFragment
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
}
Variables
{
"description": "abc123",
"name": "abc123",
"parentId": "xyz789",
"selectedMemberIds": ["xyz789"],
"visibility": "abc123"
}
Response
{
"data": {
"dashboardAdd": {
"_id": "abc123",
"childsDashboard": [Dashboard],
"createdAt": "2007-12-03",
"dashboardCount": 987,
"description": "xyz789",
"name": "xyz789",
"order": "xyz789",
"parentId": "abc123",
"relatedIds": ["abc123"],
"selectedMemberIds": ["xyz789"],
"visibility": "abc123"
}
}
}
dashboardEdit
Response
Returns a
Dashboard
Example
Query
mutation DashboardEdit(
$_id: String!,
$description: String,
$name: String!,
$parentId: String,
$selectedMemberIds: [String],
$visibility: String
) {
dashboardEdit(
_id: $_id,
description: $description,
name: $name,
parentId: $parentId,
selectedMemberIds: $selectedMemberIds,
visibility: $visibility
) {
_id
childsDashboard {
_id
childsDashboard {
...DashboardFragment
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
createdAt
dashboardCount
description
name
order
parentId
relatedIds
selectedMemberIds
visibility
}
}
Variables
{
"_id": "abc123",
"description": "xyz789",
"name": "abc123",
"parentId": "abc123",
"selectedMemberIds": ["xyz789"],
"visibility": "abc123"
}
Response
{
"data": {
"dashboardEdit": {
"_id": "abc123",
"childsDashboard": [Dashboard],
"createdAt": "2007-12-03",
"dashboardCount": 123,
"description": "abc123",
"name": "xyz789",
"order": "abc123",
"parentId": "xyz789",
"relatedIds": ["xyz789"],
"selectedMemberIds": ["abc123"],
"visibility": "xyz789"
}
}
}
dashboardItemAdd
Response
Returns a
DashboardItem
Example
Query
mutation DashboardItemAdd(
$dashboardId: String,
$isDateRange: Boolean,
$layout: String,
$name: String,
$type: String,
$vizState: String
) {
dashboardItemAdd(
dashboardId: $dashboardId,
isDateRange: $isDateRange,
layout: $layout,
name: $name,
type: $type,
vizState: $vizState
) {
_id
dashboardId
isDateRange
layout
name
type
vizState
}
}
Variables
{
"dashboardId": "xyz789",
"isDateRange": false,
"layout": "xyz789",
"name": "xyz789",
"type": "abc123",
"vizState": "abc123"
}
Response
{
"data": {
"dashboardItemAdd": {
"_id": "abc123",
"dashboardId": "xyz789",
"isDateRange": false,
"layout": "abc123",
"name": "abc123",
"type": "xyz789",
"vizState": "abc123"
}
}
}
dashboardItemEdit
Response
Returns a
DashboardItem
Example
Query
mutation DashboardItemEdit(
$_id: String!,
$dashboardId: String,
$layout: String,
$name: String,
$type: String,
$vizState: String
) {
dashboardItemEdit(
_id: $_id,
dashboardId: $dashboardId,
layout: $layout,
name: $name,
type: $type,
vizState: $vizState
) {
_id
dashboardId
isDateRange
layout
name
type
vizState
}
}
Variables
{
"_id": "xyz789",
"dashboardId": "xyz789",
"layout": "abc123",
"name": "xyz789",
"type": "xyz789",
"vizState": "xyz789"
}
Response
{
"data": {
"dashboardItemEdit": {
"_id": "xyz789",
"dashboardId": "xyz789",
"isDateRange": false,
"layout": "xyz789",
"name": "xyz789",
"type": "xyz789",
"vizState": "abc123"
}
}
}
dashboardItemRemove
dashboardRemove
dealsAdd
Response
Returns a
Deal
Arguments
| Name | Description |
|---|---|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
companyIds -
[String]
|
|
customFieldsData -
JSON
|
|
customerIds -
[String]
|
|
description -
String
|
|
isComplete -
Boolean
|
|
labelIds -
[String]
|
|
name -
String!
|
|
order -
Int
|
|
paymentsData -
JSON
|
|
priority -
String
|
|
proccessId -
String
|
|
productsData -
JSON
|
|
reminderMinute -
Int
|
|
sourceConversationIds -
[String]
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
Example
Query
mutation DealsAdd(
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$companyIds: [String],
$customFieldsData: JSON,
$customerIds: [String],
$description: String,
$isComplete: Boolean,
$labelIds: [String],
$name: String!,
$order: Int,
$paymentsData: JSON,
$priority: String,
$proccessId: String,
$productsData: JSON,
$reminderMinute: Int,
$sourceConversationIds: [String],
$stageId: String,
$startDate: Date,
$status: String
) {
dealsAdd(
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
companyIds: $companyIds,
customFieldsData: $customFieldsData,
customerIds: $customerIds,
description: $description,
isComplete: $isComplete,
labelIds: $labelIds,
name: $name,
order: $order,
paymentsData: $paymentsData,
priority: $priority,
proccessId: $proccessId,
productsData: $productsData,
reminderMinute: $reminderMinute,
sourceConversationIds: $sourceConversationIds,
stageId: $stageId,
startDate: $startDate,
status: $status
) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"aboveItemId": "abc123",
"assignedUserIds": ["abc123"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"companyIds": ["xyz789"],
"customFieldsData": {},
"customerIds": ["abc123"],
"description": "xyz789",
"isComplete": false,
"labelIds": ["xyz789"],
"name": "xyz789",
"order": 123,
"paymentsData": {},
"priority": "abc123",
"proccessId": "abc123",
"productsData": {},
"reminderMinute": 123,
"sourceConversationIds": ["xyz789"],
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789"
}
Response
{
"data": {
"dealsAdd": {
"_id": "xyz789",
"amount": {},
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "xyz789",
"products": {},
"productsData": {},
"reminderMinute": 123,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
dealsArchive
Example
Query
mutation DealsArchive(
$proccessId: String,
$stageId: String!
) {
dealsArchive(
proccessId: $proccessId,
stageId: $stageId
)
}
Variables
{
"proccessId": "xyz789",
"stageId": "xyz789"
}
Response
{"data": {"dealsArchive": "abc123"}}
dealsChange
Response
Returns a
Deal
Example
Query
mutation DealsChange(
$aboveItemId: String,
$destinationStageId: String!,
$itemId: String!,
$proccessId: String,
$sourceStageId: String
) {
dealsChange(
aboveItemId: $aboveItemId,
destinationStageId: $destinationStageId,
itemId: $itemId,
proccessId: $proccessId,
sourceStageId: $sourceStageId
) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"aboveItemId": "xyz789",
"destinationStageId": "abc123",
"itemId": "abc123",
"proccessId": "abc123",
"sourceStageId": "xyz789"
}
Response
{
"data": {
"dealsChange": {
"_id": "xyz789",
"amount": {},
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "xyz789",
"order": 987.65,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "abc123",
"products": {},
"productsData": {},
"reminderMinute": 123,
"score": 987.65,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
dealsCopy
Example
Query
mutation DealsCopy(
$_id: String!,
$proccessId: String
) {
dealsCopy(
_id: $_id,
proccessId: $proccessId
) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"_id": "xyz789",
"proccessId": "abc123"
}
Response
{
"data": {
"dealsCopy": {
"_id": "abc123",
"amount": {},
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "abc123",
"products": {},
"productsData": {},
"reminderMinute": 987,
"score": 987.65,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
dealsEdit
Response
Returns a
Deal
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
isComplete -
Boolean
|
|
name -
String
|
|
order -
Int
|
|
paymentsData -
JSON
|
|
priority -
String
|
|
proccessId -
String
|
|
productsData -
JSON
|
|
reminderMinute -
Int
|
|
sourceConversationIds -
[String]
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
Example
Query
mutation DealsEdit(
$_id: String!,
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$customFieldsData: JSON,
$description: String,
$isComplete: Boolean,
$name: String,
$order: Int,
$paymentsData: JSON,
$priority: String,
$proccessId: String,
$productsData: JSON,
$reminderMinute: Int,
$sourceConversationIds: [String],
$stageId: String,
$startDate: Date,
$status: String
) {
dealsEdit(
_id: $_id,
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
customFieldsData: $customFieldsData,
description: $description,
isComplete: $isComplete,
name: $name,
order: $order,
paymentsData: $paymentsData,
priority: $priority,
proccessId: $proccessId,
productsData: $productsData,
reminderMinute: $reminderMinute,
sourceConversationIds: $sourceConversationIds,
stageId: $stageId,
startDate: $startDate,
status: $status
) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"_id": "abc123",
"aboveItemId": "xyz789",
"assignedUserIds": ["xyz789"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"isComplete": true,
"name": "xyz789",
"order": 123,
"paymentsData": {},
"priority": "xyz789",
"proccessId": "xyz789",
"productsData": {},
"reminderMinute": 123,
"sourceConversationIds": ["abc123"],
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123"
}
Response
{
"data": {
"dealsEdit": {
"_id": "abc123",
"amount": {},
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": true,
"isComplete": false,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 123.45,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "xyz789",
"products": {},
"productsData": {},
"reminderMinute": 123,
"score": 987.65,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
dealsRemove
Example
Query
mutation DealsRemove($_id: String!) {
dealsRemove(_id: $_id) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"dealsRemove": {
"_id": "abc123",
"amount": {},
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": true,
"isComplete": false,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 123.45,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "abc123",
"products": {},
"productsData": {},
"reminderMinute": 987,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
dealsWatch
Example
Query
mutation DealsWatch(
$_id: String,
$isAdd: Boolean
) {
dealsWatch(
_id: $_id,
isAdd: $isAdd
) {
_id
amount
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
paymentsData
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
products
productsData
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "xyz789", "isAdd": false}
Response
{
"data": {
"dealsWatch": {
"_id": "xyz789",
"amount": {},
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "xyz789",
"number": "abc123",
"order": 987.65,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "abc123",
"products": {},
"productsData": {},
"reminderMinute": 123,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
departmentsAdd
Response
Returns a
Department
Example
Query
mutation DepartmentsAdd(
$code: String,
$description: String,
$parentId: String,
$supervisorId: String,
$title: String,
$userIds: [String]
) {
departmentsAdd(
code: $code,
description: $description,
parentId: $parentId,
supervisorId: $supervisorId,
title: $title,
userIds: $userIds
) {
_id
childCount
children {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
code
description
parent {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
parentId
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userCount
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"code": "xyz789",
"description": "xyz789",
"parentId": "xyz789",
"supervisorId": "xyz789",
"title": "abc123",
"userIds": ["abc123"]
}
Response
{
"data": {
"departmentsAdd": {
"_id": "abc123",
"childCount": 987,
"children": [Department],
"code": "abc123",
"description": "xyz789",
"parent": Department,
"parentId": "xyz789",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userCount": 123,
"userIds": ["xyz789"],
"users": [User]
}
}
}
departmentsEdit
Response
Returns a
Department
Example
Query
mutation DepartmentsEdit(
$_id: String!,
$code: String,
$description: String,
$parentId: String,
$supervisorId: String,
$title: String,
$userIds: [String]
) {
departmentsEdit(
_id: $_id,
code: $code,
description: $description,
parentId: $parentId,
supervisorId: $supervisorId,
title: $title,
userIds: $userIds
) {
_id
childCount
children {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
code
description
parent {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
parentId
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userCount
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "abc123",
"code": "abc123",
"description": "abc123",
"parentId": "xyz789",
"supervisorId": "xyz789",
"title": "abc123",
"userIds": ["xyz789"]
}
Response
{
"data": {
"departmentsEdit": {
"_id": "xyz789",
"childCount": 987,
"children": [Department],
"code": "abc123",
"description": "xyz789",
"parent": Department,
"parentId": "abc123",
"supervisor": User,
"supervisorId": "abc123",
"title": "xyz789",
"userCount": 123,
"userIds": ["xyz789"],
"users": [User]
}
}
}
departmentsRemove
doSpin
Example
Query
mutation DoSpin($_id: String!) {
doSpin(_id: $_id) {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"doSpin": {
"_id": "abc123",
"awardId": "xyz789",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
}
}
donateCampaignsAdd
Response
Returns a
DonateCampaign
Example
Query
mutation DonateCampaignsAdd(
$attachment: AttachmentInput,
$awards: JSON,
$description: String,
$endDate: Date,
$finishDateOfUse: Date,
$maxScore: Float,
$startDate: Date,
$status: String,
$title: String
) {
donateCampaignsAdd(
attachment: $attachment,
awards: $awards,
description: $description,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
maxScore: $maxScore,
startDate: $startDate,
status: $status,
title: $title
) {
_id
attachment {
duration
name
size
type
url
}
awards
createdAt
createdBy
description
donatesCount
endDate
finishDateOfUse
maxScore
modifiedAt
modifiedBy
startDate
status
title
}
}
Variables
{
"attachment": AttachmentInput,
"awards": {},
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 987.65,
"startDate": "2007-12-03",
"status": "abc123",
"title": "abc123"
}
Response
{
"data": {
"donateCampaignsAdd": {
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"donatesCount": 987,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 123.45,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
}
}
donateCampaignsEdit
Response
Returns a
DonateCampaign
Example
Query
mutation DonateCampaignsEdit(
$_id: String!,
$attachment: AttachmentInput,
$awards: JSON,
$description: String,
$endDate: Date,
$finishDateOfUse: Date,
$maxScore: Float,
$startDate: Date,
$status: String,
$title: String
) {
donateCampaignsEdit(
_id: $_id,
attachment: $attachment,
awards: $awards,
description: $description,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
maxScore: $maxScore,
startDate: $startDate,
status: $status,
title: $title
) {
_id
attachment {
duration
name
size
type
url
}
awards
createdAt
createdBy
description
donatesCount
endDate
finishDateOfUse
maxScore
modifiedAt
modifiedBy
startDate
status
title
}
}
Variables
{
"_id": "xyz789",
"attachment": AttachmentInput,
"awards": {},
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 123.45,
"startDate": "2007-12-03",
"status": "abc123",
"title": "xyz789"
}
Response
{
"data": {
"donateCampaignsEdit": {
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"donatesCount": 987,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"title": "xyz789"
}
}
}
donateCampaignsRemove
donatesAdd
Response
Returns a
Donate
Example
Query
mutation DonatesAdd(
$campaignId: String,
$donateScore: Float,
$ownerId: String,
$ownerType: String,
$usedAt: Date
) {
donatesAdd(
campaignId: $campaignId,
donateScore: $donateScore,
ownerId: $ownerId,
ownerType: $ownerType,
usedAt: $usedAt
) {
_id
awardId
campaign
campaignId
createdAt
donateScore
owner
ownerId
ownerType
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "xyz789",
"donateScore": 123.45,
"ownerId": "abc123",
"ownerType": "abc123",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"donatesAdd": {
"_id": "xyz789",
"awardId": "abc123",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"donateScore": 987.65,
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
}
}
donatesRemove
emailTemplatesAdd
Response
Returns an
EmailTemplate
Example
Query
mutation EmailTemplatesAdd(
$content: String,
$name: String!
) {
emailTemplatesAdd(
content: $content,
name: $name
) {
_id
content
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
modifiedAt
name
status
}
}
Variables
{
"content": "abc123",
"name": "xyz789"
}
Response
{
"data": {
"emailTemplatesAdd": {
"_id": "abc123",
"content": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUser": User,
"modifiedAt": "2007-12-03",
"name": "abc123",
"status": "abc123"
}
}
}
emailTemplatesChangeStatus
Response
Returns an
EmailTemplate
Example
Query
mutation EmailTemplatesChangeStatus(
$_id: String!,
$status: String
) {
emailTemplatesChangeStatus(
_id: $_id,
status: $status
) {
_id
content
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
modifiedAt
name
status
}
}
Variables
{
"_id": "xyz789",
"status": "abc123"
}
Response
{
"data": {
"emailTemplatesChangeStatus": {
"_id": "xyz789",
"content": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUser": User,
"modifiedAt": "2007-12-03",
"name": "abc123",
"status": "xyz789"
}
}
}
emailTemplatesDuplicate
Response
Returns an
EmailTemplate
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation EmailTemplatesDuplicate($_id: String!) {
emailTemplatesDuplicate(_id: $_id) {
_id
content
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
modifiedAt
name
status
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"emailTemplatesDuplicate": {
"_id": "abc123",
"content": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUser": User,
"modifiedAt": "2007-12-03",
"name": "abc123",
"status": "abc123"
}
}
}
emailTemplatesEdit
Response
Returns an
EmailTemplate
Example
Query
mutation EmailTemplatesEdit(
$_id: String!,
$content: String,
$name: String!
) {
emailTemplatesEdit(
_id: $_id,
content: $content,
name: $name
) {
_id
content
createdAt
createdBy
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
modifiedAt
name
status
}
}
Variables
{
"_id": "xyz789",
"content": "xyz789",
"name": "xyz789"
}
Response
{
"data": {
"emailTemplatesEdit": {
"_id": "xyz789",
"content": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"modifiedAt": "2007-12-03",
"name": "abc123",
"status": "abc123"
}
}
}
emailTemplatesRemove
emojiReact
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
contentId -
String!
|
|
contentType -
ReactionContentType!
|
|
type -
String
|
Example
Query
mutation EmojiReact(
$contentId: String!,
$contentType: ReactionContentType!,
$type: String
) {
emojiReact(
contentId: $contentId,
contentType: $contentType,
type: $type
)
}
Variables
{
"contentId": "xyz789",
"contentType": "exmFeed",
"type": "abc123"
}
Response
{"data": {"emojiReact": "xyz789"}}
engageMessageAdd
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
brandIds -
[String]
|
|
customerIds -
[String]
|
|
customerTagIds -
[String]
|
|
email -
EngageMessageEmail
|
|
fromUserId -
String
|
|
isDraft -
Boolean
|
|
isLive -
Boolean
|
|
kind -
String!
|
|
messenger -
EngageMessageMessenger
|
|
method -
String!
|
|
scheduleDate -
EngageScheduleDateInput
|
|
segmentIds -
[String]
|
|
shortMessage -
EngageMessageSmsInput
|
|
stopDate -
Date
|
|
title -
String!
|
|
type -
String
|
Example
Query
mutation EngageMessageAdd(
$brandIds: [String],
$customerIds: [String],
$customerTagIds: [String],
$email: EngageMessageEmail,
$fromUserId: String,
$isDraft: Boolean,
$isLive: Boolean,
$kind: String!,
$messenger: EngageMessageMessenger,
$method: String!,
$scheduleDate: EngageScheduleDateInput,
$segmentIds: [String],
$shortMessage: EngageMessageSmsInput,
$stopDate: Date,
$title: String!,
$type: String
) {
engageMessageAdd(
brandIds: $brandIds,
customerIds: $customerIds,
customerTagIds: $customerTagIds,
email: $email,
fromUserId: $fromUserId,
isDraft: $isDraft,
isLive: $isLive,
kind: $kind,
messenger: $messenger,
method: $method,
scheduleDate: $scheduleDate,
segmentIds: $segmentIds,
shortMessage: $shortMessage,
stopDate: $stopDate,
title: $title,
type: $type
) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{
"brandIds": ["xyz789"],
"customerIds": ["xyz789"],
"customerTagIds": ["xyz789"],
"email": EngageMessageEmail,
"fromUserId": "abc123",
"isDraft": true,
"isLive": false,
"kind": "abc123",
"messenger": EngageMessageMessenger,
"method": "abc123",
"scheduleDate": EngageScheduleDateInput,
"segmentIds": ["xyz789"],
"shortMessage": EngageMessageSmsInput,
"stopDate": "2007-12-03",
"title": "xyz789",
"type": "abc123"
}
Response
{
"data": {
"engageMessageAdd": {
"_id": "abc123",
"brand": Brand,
"brandIds": ["abc123"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUserName": "xyz789",
"customerIds": ["abc123"],
"customerTagIds": ["abc123"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "abc123",
"getTags": [Tag],
"isDraft": false,
"isLive": false,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"xyz789"
],
"method": "abc123",
"runCount": 987,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["xyz789"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "abc123",
"totalCustomersCount": 123,
"type": "xyz789",
"validCustomersCount": 123
}
}
}
engageMessageCopy
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation EngageMessageCopy($_id: String!) {
engageMessageCopy(_id: $_id) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"engageMessageCopy": {
"_id": "xyz789",
"brand": Brand,
"brandIds": ["xyz789"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUserName": "xyz789",
"customerIds": ["xyz789"],
"customerTagIds": ["xyz789"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "abc123",
"getTags": [Tag],
"isDraft": false,
"isLive": true,
"kind": "abc123",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "xyz789",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["xyz789"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "abc123",
"totalCustomersCount": 123,
"type": "abc123",
"validCustomersCount": 123
}
}
}
engageMessageEdit
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
brandIds -
[String]
|
|
customerIds -
[String]
|
|
customerTagIds -
[String]
|
|
email -
EngageMessageEmail
|
|
fromUserId -
String
|
|
isDraft -
Boolean
|
|
isLive -
Boolean
|
|
kind -
String!
|
|
messenger -
EngageMessageMessenger
|
|
method -
String!
|
|
scheduleDate -
EngageScheduleDateInput
|
|
segmentIds -
[String]
|
|
shortMessage -
EngageMessageSmsInput
|
|
stopDate -
Date
|
|
title -
String!
|
|
type -
String
|
Example
Query
mutation EngageMessageEdit(
$_id: String!,
$brandIds: [String],
$customerIds: [String],
$customerTagIds: [String],
$email: EngageMessageEmail,
$fromUserId: String,
$isDraft: Boolean,
$isLive: Boolean,
$kind: String!,
$messenger: EngageMessageMessenger,
$method: String!,
$scheduleDate: EngageScheduleDateInput,
$segmentIds: [String],
$shortMessage: EngageMessageSmsInput,
$stopDate: Date,
$title: String!,
$type: String
) {
engageMessageEdit(
_id: $_id,
brandIds: $brandIds,
customerIds: $customerIds,
customerTagIds: $customerTagIds,
email: $email,
fromUserId: $fromUserId,
isDraft: $isDraft,
isLive: $isLive,
kind: $kind,
messenger: $messenger,
method: $method,
scheduleDate: $scheduleDate,
segmentIds: $segmentIds,
shortMessage: $shortMessage,
stopDate: $stopDate,
title: $title,
type: $type
) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{
"_id": "xyz789",
"brandIds": ["xyz789"],
"customerIds": ["xyz789"],
"customerTagIds": ["xyz789"],
"email": EngageMessageEmail,
"fromUserId": "xyz789",
"isDraft": true,
"isLive": true,
"kind": "xyz789",
"messenger": EngageMessageMessenger,
"method": "xyz789",
"scheduleDate": EngageScheduleDateInput,
"segmentIds": ["abc123"],
"shortMessage": EngageMessageSmsInput,
"stopDate": "2007-12-03",
"title": "abc123",
"type": "xyz789"
}
Response
{
"data": {
"engageMessageEdit": {
"_id": "xyz789",
"brand": Brand,
"brandIds": ["xyz789"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUserName": "xyz789",
"customerIds": ["xyz789"],
"customerTagIds": ["xyz789"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "abc123",
"getTags": [Tag],
"isDraft": true,
"isLive": false,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "abc123",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["xyz789"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "abc123",
"totalCustomersCount": 987,
"type": "abc123",
"validCustomersCount": 123
}
}
}
engageMessageRemove
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation EngageMessageRemove($_id: String!) {
engageMessageRemove(_id: $_id) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"engageMessageRemove": {
"_id": "abc123",
"brand": Brand,
"brandIds": ["abc123"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUserName": "xyz789",
"customerIds": ["abc123"],
"customerTagIds": ["abc123"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "xyz789",
"getTags": [Tag],
"isDraft": true,
"isLive": false,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "xyz789",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["abc123"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["abc123"],
"title": "xyz789",
"totalCustomersCount": 987,
"type": "xyz789",
"validCustomersCount": 123
}
}
}
engageMessageRemoveVerifiedEmail
engageMessageSendTestEmail
Response
Returns a
String
Example
Query
mutation EngageMessageSendTestEmail(
$content: String!,
$from: String!,
$title: String!,
$to: String!
) {
engageMessageSendTestEmail(
content: $content,
from: $from,
title: $title,
to: $to
)
}
Variables
{
"content": "xyz789",
"from": "abc123",
"title": "xyz789",
"to": "abc123"
}
Response
{
"data": {
"engageMessageSendTestEmail": "xyz789"
}
}
engageMessageSetLive
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation EngageMessageSetLive($_id: String!) {
engageMessageSetLive(_id: $_id) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"engageMessageSetLive": {
"_id": "abc123",
"brand": Brand,
"brandIds": ["abc123"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUserName": "xyz789",
"customerIds": ["abc123"],
"customerTagIds": ["xyz789"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "abc123",
"getTags": [Tag],
"isDraft": true,
"isLive": false,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "abc123",
"runCount": 987,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["xyz789"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["abc123"],
"title": "xyz789",
"totalCustomersCount": 123,
"type": "xyz789",
"validCustomersCount": 987
}
}
}
engageMessageSetLiveManual
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation EngageMessageSetLiveManual($_id: String!) {
engageMessageSetLiveManual(_id: $_id) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"engageMessageSetLiveManual": {
"_id": "xyz789",
"brand": Brand,
"brandIds": ["xyz789"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUserName": "abc123",
"customerIds": ["abc123"],
"customerTagIds": ["xyz789"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "abc123",
"getTags": [Tag],
"isDraft": false,
"isLive": true,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"xyz789"
],
"method": "abc123",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["abc123"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "abc123",
"totalCustomersCount": 123,
"type": "abc123",
"validCustomersCount": 123
}
}
}
engageMessageSetPause
Response
Returns an
EngageMessage
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation EngageMessageSetPause($_id: String!) {
engageMessageSetPause(_id: $_id) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
createdAt
createdBy
createdUserName
customerIds
customerTagIds
customerTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
email
fromIntegration
fromUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
fromUserId
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
isDraft
isLive
kind
lastRunAt
logs {
_id
createdAt
engageMessageId
message
type
}
messenger
messengerReceivedCustomerIds
method
runCount
scheduleDate {
dateTime
day
month
type
}
segmentIds
segments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
shortMessage {
content
from
fromIntegrationId
}
smsStats
stats
stopDate
tagIds
title
totalCustomersCount
type
validCustomersCount
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"engageMessageSetPause": {
"_id": "abc123",
"brand": Brand,
"brandIds": ["xyz789"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdUserName": "xyz789",
"customerIds": ["abc123"],
"customerTagIds": ["xyz789"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "xyz789",
"getTags": [Tag],
"isDraft": false,
"isLive": true,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"abc123"
],
"method": "xyz789",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["abc123"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "abc123",
"totalCustomersCount": 987,
"type": "xyz789",
"validCustomersCount": 123
}
}
}
engageMessageVerifyEmail
engagesUpdateConfigs
excludeUserSkill
Example
Query
mutation ExcludeUserSkill(
$_id: String!,
$memberIds: [String]!
) {
excludeUserSkill(
_id: $_id,
memberIds: $memberIds
)
}
Variables
{
"_id": "xyz789",
"memberIds": ["abc123"]
}
Response
{"data": {"excludeUserSkill": {}}}
exmFeedAdd
Response
Returns an
ExmFeed
Arguments
| Name | Description |
|---|---|
attachments -
[JSON]
|
|
contentType -
ContentType!
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
eventData -
ExmEventDataInput
|
|
images -
[JSON]
|
|
isPinned -
Boolean
|
|
recipientIds -
[String]
|
|
title -
String!
|
Example
Query
mutation ExmFeedAdd(
$attachments: [JSON],
$contentType: ContentType!,
$createdAt: Date,
$customFieldsData: JSON,
$description: String,
$eventData: ExmEventDataInput,
$images: [JSON],
$isPinned: Boolean,
$recipientIds: [String],
$title: String!
) {
exmFeedAdd(
attachments: $attachments,
contentType: $contentType,
createdAt: $createdAt,
customFieldsData: $customFieldsData,
description: $description,
eventData: $eventData,
images: $images,
isPinned: $isPinned,
recipientIds: $recipientIds,
title: $title
) {
_id
attachments
ceremonyData {
howManyYear
startedDate
willDate
year
}
commentCount
contentType
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
endDate
eventData {
endDate
goingUserIds
interestedUserIds
startDate
visibility
where
}
eventGoingUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
eventInterestedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
heartCount
images
isHearted
isLiked
isPinned
likeCount
recipientIds
recipients {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
startDate
title
updatedAt
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
visibility
where
}
}
Variables
{
"attachments": [{}],
"contentType": "birthday",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "abc123",
"eventData": ExmEventDataInput,
"images": [{}],
"isPinned": true,
"recipientIds": ["abc123"],
"title": "xyz789"
}
Response
{
"data": {
"exmFeedAdd": {
"_id": "xyz789",
"attachments": {},
"ceremonyData": ExmCeremonyData,
"commentCount": 123,
"contentType": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"endDate": "2007-12-03",
"eventData": ExmEventData,
"eventGoingUsers": [User],
"eventInterestedUsers": [User],
"heartCount": 987,
"images": {},
"isHearted": true,
"isLiked": true,
"isPinned": true,
"likeCount": 123,
"recipientIds": ["abc123"],
"recipients": [User],
"startDate": "2007-12-03",
"title": "xyz789",
"updatedAt": "2007-12-03",
"updatedUser": User,
"visibility": "xyz789",
"where": "xyz789"
}
}
}
exmFeedEdit
Response
Returns an
ExmFeed
Example
Query
mutation ExmFeedEdit(
$_id: String,
$attachments: [JSON],
$contentType: ContentType!,
$createdAt: Date,
$customFieldsData: JSON,
$description: String,
$eventData: ExmEventDataInput,
$images: [JSON],
$isPinned: Boolean,
$recipientIds: [String],
$title: String!
) {
exmFeedEdit(
_id: $_id,
attachments: $attachments,
contentType: $contentType,
createdAt: $createdAt,
customFieldsData: $customFieldsData,
description: $description,
eventData: $eventData,
images: $images,
isPinned: $isPinned,
recipientIds: $recipientIds,
title: $title
) {
_id
attachments
ceremonyData {
howManyYear
startedDate
willDate
year
}
commentCount
contentType
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
endDate
eventData {
endDate
goingUserIds
interestedUserIds
startDate
visibility
where
}
eventGoingUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
eventInterestedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
heartCount
images
isHearted
isLiked
isPinned
likeCount
recipientIds
recipients {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
startDate
title
updatedAt
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
visibility
where
}
}
Variables
{
"_id": "xyz789",
"attachments": [{}],
"contentType": "birthday",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"eventData": ExmEventDataInput,
"images": [{}],
"isPinned": true,
"recipientIds": ["abc123"],
"title": "abc123"
}
Response
{
"data": {
"exmFeedEdit": {
"_id": "xyz789",
"attachments": {},
"ceremonyData": ExmCeremonyData,
"commentCount": 123,
"contentType": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"endDate": "2007-12-03",
"eventData": ExmEventData,
"eventGoingUsers": [User],
"eventInterestedUsers": [User],
"heartCount": 123,
"images": {},
"isHearted": false,
"isLiked": true,
"isPinned": false,
"likeCount": 987,
"recipientIds": ["xyz789"],
"recipients": [User],
"startDate": "2007-12-03",
"title": "xyz789",
"updatedAt": "2007-12-03",
"updatedUser": User,
"visibility": "xyz789",
"where": "abc123"
}
}
}
exmFeedEventGoingOrInterested
Response
Returns an
ExmFeed
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
goingOrInterested -
ExmGoingOrInterested!
|
Example
Query
mutation ExmFeedEventGoingOrInterested(
$_id: String!,
$goingOrInterested: ExmGoingOrInterested!
) {
exmFeedEventGoingOrInterested(
_id: $_id,
goingOrInterested: $goingOrInterested
) {
_id
attachments
ceremonyData {
howManyYear
startedDate
willDate
year
}
commentCount
contentType
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
endDate
eventData {
endDate
goingUserIds
interestedUserIds
startDate
visibility
where
}
eventGoingUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
eventInterestedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
heartCount
images
isHearted
isLiked
isPinned
likeCount
recipientIds
recipients {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
startDate
title
updatedAt
updatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
visibility
where
}
}
Variables
{
"_id": "abc123",
"goingOrInterested": "going"
}
Response
{
"data": {
"exmFeedEventGoingOrInterested": {
"_id": "abc123",
"attachments": {},
"ceremonyData": ExmCeremonyData,
"commentCount": 987,
"contentType": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"endDate": "2007-12-03",
"eventData": ExmEventData,
"eventGoingUsers": [User],
"eventInterestedUsers": [User],
"heartCount": 987,
"images": {},
"isHearted": true,
"isLiked": false,
"isPinned": true,
"likeCount": 123,
"recipientIds": ["abc123"],
"recipients": [User],
"startDate": "2007-12-03",
"title": "abc123",
"updatedAt": "2007-12-03",
"updatedUser": User,
"visibility": "abc123",
"where": "abc123"
}
}
}
exmFeedRemove
exmFeedToggleIsPinned
exmThankAdd
Response
Returns an
ExmThank
Example
Query
mutation ExmThankAdd(
$description: String!,
$recipientIds: [String]!
) {
exmThankAdd(
description: $description,
recipientIds: $recipientIds
) {
_id
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
recipientIds
recipients {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
updatedAt
}
}
Variables
{
"description": "xyz789",
"recipientIds": ["xyz789"]
}
Response
{
"data": {
"exmThankAdd": {
"_id": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "abc123",
"recipientIds": ["xyz789"],
"recipients": [User],
"updatedAt": "2007-12-03"
}
}
}
exmThankEdit
Response
Returns an
ExmThank
Example
Query
mutation ExmThankEdit(
$_id: String,
$description: String!,
$recipientIds: [String]!
) {
exmThankEdit(
_id: $_id,
description: $description,
recipientIds: $recipientIds
) {
_id
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
description
recipientIds
recipients {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
updatedAt
}
}
Variables
{
"_id": "abc123",
"description": "abc123",
"recipientIds": ["xyz789"]
}
Response
{
"data": {
"exmThankEdit": {
"_id": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "xyz789",
"recipientIds": ["abc123"],
"recipients": [User],
"updatedAt": "2007-12-03"
}
}
}
exmThankRemove
exmsAdd
Response
Returns an
Exm
Arguments
| Name | Description |
|---|---|
appearance -
ExmAppearanceInput
|
|
description -
String
|
|
features -
[ExmFeatureInput]
|
|
logo -
AttachmentInput
|
|
name -
String
|
|
welcomeContent -
[ExmWelcomeContentInput]
|
Example
Query
mutation ExmsAdd(
$appearance: ExmAppearanceInput,
$description: String,
$features: [ExmFeatureInput],
$logo: AttachmentInput,
$name: String,
$welcomeContent: [ExmWelcomeContentInput]
) {
exmsAdd(
appearance: $appearance,
description: $description,
features: $features,
logo: $logo,
name: $name,
welcomeContent: $welcomeContent
) {
_id
appearance {
primaryColor
secondaryColor
}
createdAt
createdBy
description
features {
_id
contentId
contentType
description
icon
name
subContentId
}
logo
name
welcomeContent {
_id
content
image
title
}
}
}
Variables
{
"appearance": ExmAppearanceInput,
"description": "xyz789",
"features": [ExmFeatureInput],
"logo": AttachmentInput,
"name": "abc123",
"welcomeContent": [ExmWelcomeContentInput]
}
Response
{
"data": {
"exmsAdd": {
"_id": "abc123",
"appearance": ExmAppearance,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"features": [ExmFeature],
"logo": {},
"name": "xyz789",
"welcomeContent": [ExmWelcomeContent]
}
}
}
exmsEdit
Response
Returns an
Exm
Arguments
| Name | Description |
|---|---|
_id -
String
|
|
appearance -
ExmAppearanceInput
|
|
description -
String
|
|
features -
[ExmFeatureInput]
|
|
logo -
AttachmentInput
|
|
name -
String
|
|
welcomeContent -
[ExmWelcomeContentInput]
|
Example
Query
mutation ExmsEdit(
$_id: String,
$appearance: ExmAppearanceInput,
$description: String,
$features: [ExmFeatureInput],
$logo: AttachmentInput,
$name: String,
$welcomeContent: [ExmWelcomeContentInput]
) {
exmsEdit(
_id: $_id,
appearance: $appearance,
description: $description,
features: $features,
logo: $logo,
name: $name,
welcomeContent: $welcomeContent
) {
_id
appearance {
primaryColor
secondaryColor
}
createdAt
createdBy
description
features {
_id
contentId
contentType
description
icon
name
subContentId
}
logo
name
welcomeContent {
_id
content
image
title
}
}
}
Variables
{
"_id": "abc123",
"appearance": ExmAppearanceInput,
"description": "abc123",
"features": [ExmFeatureInput],
"logo": AttachmentInput,
"name": "abc123",
"welcomeContent": [ExmWelcomeContentInput]
}
Response
{
"data": {
"exmsEdit": {
"_id": "xyz789",
"appearance": ExmAppearance,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"features": [ExmFeature],
"logo": {},
"name": "abc123",
"welcomeContent": [ExmWelcomeContent]
}
}
}
exmsRemove
fieldsAdd
Response
Returns a
Field
Arguments
| Name | Description |
|---|---|
associatedFieldId -
String
|
|
canHide -
Boolean
|
|
code -
String
|
|
contentType -
String!
|
|
contentTypeId -
String
|
|
description -
String
|
|
groupId -
String
|
|
isRequired -
Boolean
|
|
isVisible -
Boolean
|
|
locationOptions -
[LocationOptionInput]
|
|
logic -
LogicInput
|
|
objectListConfigs -
[objectListConfigInput]
|
|
options -
[String]
|
|
order -
Int
|
|
searchable -
Boolean
|
|
showInCard -
Boolean
|
|
text -
String
|
|
type -
String
|
|
validation -
String
|
Example
Query
mutation FieldsAdd(
$associatedFieldId: String,
$canHide: Boolean,
$code: String,
$contentType: String!,
$contentTypeId: String,
$description: String,
$groupId: String,
$isRequired: Boolean,
$isVisible: Boolean,
$locationOptions: [LocationOptionInput],
$logic: LogicInput,
$objectListConfigs: [objectListConfigInput],
$options: [String],
$order: Int,
$searchable: Boolean,
$showInCard: Boolean,
$text: String,
$type: String,
$validation: String
) {
fieldsAdd(
associatedFieldId: $associatedFieldId,
canHide: $canHide,
code: $code,
contentType: $contentType,
contentTypeId: $contentTypeId,
description: $description,
groupId: $groupId,
isRequired: $isRequired,
isVisible: $isVisible,
locationOptions: $locationOptions,
logic: $logic,
objectListConfigs: $objectListConfigs,
options: $options,
order: $order,
searchable: $searchable,
showInCard: $showInCard,
text: $text,
type: $type,
validation: $validation
) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{
"associatedFieldId": "abc123",
"canHide": true,
"code": "xyz789",
"contentType": "abc123",
"contentTypeId": "xyz789",
"description": "xyz789",
"groupId": "xyz789",
"isRequired": true,
"isVisible": true,
"locationOptions": [LocationOptionInput],
"logic": LogicInput,
"objectListConfigs": [objectListConfigInput],
"options": ["xyz789"],
"order": 987,
"searchable": false,
"showInCard": false,
"text": "xyz789",
"type": "abc123",
"validation": "xyz789"
}
Response
{
"data": {
"fieldsAdd": {
"_id": "abc123",
"associatedField": Field,
"associatedFieldId": "xyz789",
"canHide": true,
"code": "xyz789",
"column": 123,
"content": "xyz789",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"description": "abc123",
"groupId": "abc123",
"groupName": "abc123",
"isDefinedByErxes": true,
"isRequired": false,
"isVisible": true,
"isVisibleInDetail": true,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"locationOptions": [LocationOption],
"logicAction": "abc123",
"logics": [Logic],
"name": "abc123",
"objectListConfigs": [ObjectListConfig],
"options": ["xyz789"],
"order": 123,
"pageNumber": 123,
"productCategoryId": "xyz789",
"products": [Product],
"searchable": false,
"showInCard": false,
"text": "xyz789",
"type": "xyz789",
"validation": "abc123"
}
}
}
fieldsBulkAddAndEdit
Response
Returns
[Field]
Arguments
| Name | Description |
|---|---|
addingFields -
[FieldItem]
|
|
contentType -
String!
|
|
contentTypeId -
String
|
|
editingFields -
[FieldItem]
|
Example
Query
mutation FieldsBulkAddAndEdit(
$addingFields: [FieldItem],
$contentType: String!,
$contentTypeId: String,
$editingFields: [FieldItem]
) {
fieldsBulkAddAndEdit(
addingFields: $addingFields,
contentType: $contentType,
contentTypeId: $contentTypeId,
editingFields: $editingFields
) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{
"addingFields": [FieldItem],
"contentType": "abc123",
"contentTypeId": "abc123",
"editingFields": [FieldItem]
}
Response
{
"data": {
"fieldsBulkAddAndEdit": [
{
"_id": "abc123",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": false,
"code": "xyz789",
"column": 123,
"content": "abc123",
"contentType": "xyz789",
"contentTypeId": "abc123",
"description": "xyz789",
"groupId": "abc123",
"groupName": "abc123",
"isDefinedByErxes": true,
"isRequired": false,
"isVisible": false,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "xyz789",
"locationOptions": [LocationOption],
"logicAction": "abc123",
"logics": [Logic],
"name": "abc123",
"objectListConfigs": [ObjectListConfig],
"options": ["xyz789"],
"order": 123,
"pageNumber": 987,
"productCategoryId": "xyz789",
"products": [Product],
"searchable": false,
"showInCard": false,
"text": "xyz789",
"type": "xyz789",
"validation": "abc123"
}
]
}
}
fieldsEdit
Response
Returns a
Field
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
associatedFieldId -
String
|
|
canHide -
Boolean
|
|
code -
String
|
|
description -
String
|
|
groupId -
String
|
|
isRequired -
Boolean
|
|
isVisible -
Boolean
|
|
locationOptions -
[LocationOptionInput]
|
|
logic -
LogicInput
|
|
objectListConfigs -
[objectListConfigInput]
|
|
options -
[String]
|
|
order -
Int
|
|
searchable -
Boolean
|
|
showInCard -
Boolean
|
|
text -
String
|
|
type -
String
|
|
validation -
String
|
Example
Query
mutation FieldsEdit(
$_id: String!,
$associatedFieldId: String,
$canHide: Boolean,
$code: String,
$description: String,
$groupId: String,
$isRequired: Boolean,
$isVisible: Boolean,
$locationOptions: [LocationOptionInput],
$logic: LogicInput,
$objectListConfigs: [objectListConfigInput],
$options: [String],
$order: Int,
$searchable: Boolean,
$showInCard: Boolean,
$text: String,
$type: String,
$validation: String
) {
fieldsEdit(
_id: $_id,
associatedFieldId: $associatedFieldId,
canHide: $canHide,
code: $code,
description: $description,
groupId: $groupId,
isRequired: $isRequired,
isVisible: $isVisible,
locationOptions: $locationOptions,
logic: $logic,
objectListConfigs: $objectListConfigs,
options: $options,
order: $order,
searchable: $searchable,
showInCard: $showInCard,
text: $text,
type: $type,
validation: $validation
) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{
"_id": "abc123",
"associatedFieldId": "abc123",
"canHide": false,
"code": "xyz789",
"description": "abc123",
"groupId": "abc123",
"isRequired": false,
"isVisible": true,
"locationOptions": [LocationOptionInput],
"logic": LogicInput,
"objectListConfigs": [objectListConfigInput],
"options": ["xyz789"],
"order": 987,
"searchable": false,
"showInCard": false,
"text": "xyz789",
"type": "xyz789",
"validation": "abc123"
}
Response
{
"data": {
"fieldsEdit": {
"_id": "xyz789",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": true,
"code": "abc123",
"column": 987,
"content": "xyz789",
"contentType": "abc123",
"contentTypeId": "xyz789",
"description": "xyz789",
"groupId": "xyz789",
"groupName": "xyz789",
"isDefinedByErxes": true,
"isRequired": true,
"isVisible": false,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"locationOptions": [LocationOption],
"logicAction": "abc123",
"logics": [Logic],
"name": "xyz789",
"objectListConfigs": [ObjectListConfig],
"options": ["xyz789"],
"order": 123,
"pageNumber": 987,
"productCategoryId": "abc123",
"products": [Product],
"searchable": true,
"showInCard": false,
"text": "abc123",
"type": "xyz789",
"validation": "abc123"
}
}
}
fieldsGroupsAdd
Response
Returns a
FieldsGroup
Example
Query
mutation FieldsGroupsAdd(
$code: String,
$config: JSON,
$contentType: String,
$description: String,
$isVisible: Boolean,
$isVisibleInDetail: Boolean,
$name: String,
$order: Int
) {
fieldsGroupsAdd(
code: $code,
config: $config,
contentType: $contentType,
description: $description,
isVisible: $isVisible,
isVisibleInDetail: $isVisibleInDetail,
name: $name,
order: $order
) {
_id
code
config
contentType
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
isDefinedByErxes
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
name
order
}
}
Variables
{
"code": "abc123",
"config": {},
"contentType": "abc123",
"description": "abc123",
"isVisible": true,
"isVisibleInDetail": true,
"name": "abc123",
"order": 123
}
Response
{
"data": {
"fieldsGroupsAdd": {
"_id": "abc123",
"code": "abc123",
"config": {},
"contentType": "abc123",
"description": "xyz789",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": false,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "xyz789",
"name": "xyz789",
"order": 987
}
}
}
fieldsGroupsEdit
Response
Returns a
FieldsGroup
Example
Query
mutation FieldsGroupsEdit(
$_id: String!,
$code: String,
$config: JSON,
$contentType: String,
$description: String,
$isVisible: Boolean,
$isVisibleInDetail: Boolean,
$name: String,
$order: Int
) {
fieldsGroupsEdit(
_id: $_id,
code: $code,
config: $config,
contentType: $contentType,
description: $description,
isVisible: $isVisible,
isVisibleInDetail: $isVisibleInDetail,
name: $name,
order: $order
) {
_id
code
config
contentType
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
isDefinedByErxes
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
name
order
}
}
Variables
{
"_id": "xyz789",
"code": "xyz789",
"config": {},
"contentType": "abc123",
"description": "abc123",
"isVisible": false,
"isVisibleInDetail": true,
"name": "abc123",
"order": 123
}
Response
{
"data": {
"fieldsGroupsEdit": {
"_id": "abc123",
"code": "xyz789",
"config": {},
"contentType": "xyz789",
"description": "xyz789",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": false,
"isVisibleInDetail": true,
"lastUpdatedUser": User,
"lastUpdatedUserId": "xyz789",
"name": "abc123",
"order": 123
}
}
}
fieldsGroupsRemove
fieldsGroupsUpdateOrder
Response
Returns
[FieldsGroup]
Arguments
| Name | Description |
|---|---|
orders -
[OrderItem]
|
Example
Query
mutation FieldsGroupsUpdateOrder($orders: [OrderItem]) {
fieldsGroupsUpdateOrder(orders: $orders) {
_id
code
config
contentType
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
isDefinedByErxes
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
name
order
}
}
Variables
{"orders": [OrderItem]}
Response
{
"data": {
"fieldsGroupsUpdateOrder": [
{
"_id": "abc123",
"code": "abc123",
"config": {},
"contentType": "xyz789",
"description": "abc123",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": true,
"isVisibleInDetail": true,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"name": "abc123",
"order": 123
}
]
}
}
fieldsGroupsUpdateVisible
Response
Returns a
FieldsGroup
Example
Query
mutation FieldsGroupsUpdateVisible(
$_id: String,
$isVisible: Boolean,
$isVisibleInDetail: Boolean
) {
fieldsGroupsUpdateVisible(
_id: $_id,
isVisible: $isVisible,
isVisibleInDetail: $isVisibleInDetail
) {
_id
code
config
contentType
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
isDefinedByErxes
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
name
order
}
}
Variables
{
"_id": "abc123",
"isVisible": true,
"isVisibleInDetail": true
}
Response
{
"data": {
"fieldsGroupsUpdateVisible": {
"_id": "xyz789",
"code": "xyz789",
"config": {},
"contentType": "abc123",
"description": "abc123",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": true,
"isVisibleInDetail": true,
"lastUpdatedUser": User,
"lastUpdatedUserId": "xyz789",
"name": "abc123",
"order": 987
}
}
}
fieldsRemove
Example
Query
mutation FieldsRemove($_id: String!) {
fieldsRemove(_id: $_id) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"fieldsRemove": {
"_id": "xyz789",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": false,
"code": "abc123",
"column": 123,
"content": "xyz789",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"description": "abc123",
"groupId": "abc123",
"groupName": "abc123",
"isDefinedByErxes": false,
"isRequired": false,
"isVisible": true,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"locationOptions": [LocationOption],
"logicAction": "abc123",
"logics": [Logic],
"name": "abc123",
"objectListConfigs": [ObjectListConfig],
"options": ["xyz789"],
"order": 123,
"pageNumber": 987,
"productCategoryId": "xyz789",
"products": [Product],
"searchable": true,
"showInCard": false,
"text": "abc123",
"type": "abc123",
"validation": "xyz789"
}
}
}
fieldsUpdateOrder
Response
Returns
[Field]
Arguments
| Name | Description |
|---|---|
orders -
[OrderItem]
|
Example
Query
mutation FieldsUpdateOrder($orders: [OrderItem]) {
fieldsUpdateOrder(orders: $orders) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{"orders": [OrderItem]}
Response
{
"data": {
"fieldsUpdateOrder": [
{
"_id": "xyz789",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": false,
"code": "xyz789",
"column": 123,
"content": "abc123",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"description": "xyz789",
"groupId": "xyz789",
"groupName": "xyz789",
"isDefinedByErxes": true,
"isRequired": false,
"isVisible": false,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"locationOptions": [LocationOption],
"logicAction": "abc123",
"logics": [Logic],
"name": "abc123",
"objectListConfigs": [ObjectListConfig],
"options": ["abc123"],
"order": 987,
"pageNumber": 987,
"productCategoryId": "abc123",
"products": [Product],
"searchable": false,
"showInCard": false,
"text": "xyz789",
"type": "abc123",
"validation": "abc123"
}
]
}
}
fieldsUpdateVisible
Response
Returns a
Field
Example
Query
mutation FieldsUpdateVisible(
$_id: String!,
$isVisible: Boolean,
$isVisibleInDetail: Boolean
) {
fieldsUpdateVisible(
_id: $_id,
isVisible: $isVisible,
isVisibleInDetail: $isVisibleInDetail
) {
_id
associatedField {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
lastUpdatedUserId
locationOptions {
description
lat
lng
}
logicAction
logics {
fieldId
logicOperator
logicValue
}
name
objectListConfigs {
key
label
type
}
options
order
pageNumber
productCategoryId
products {
_id
attachment {
...AttachmentFragment
}
attachmentMore {
...AttachmentFragment
}
category {
...ProductCategoryFragment
}
categoryId
code
createdAt
customFieldsData
description
getTags {
...TagFragment
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
...CompanyFragment
}
vendorId
}
searchable
showInCard
text
type
validation
}
}
Variables
{
"_id": "abc123",
"isVisible": true,
"isVisibleInDetail": true
}
Response
{
"data": {
"fieldsUpdateVisible": {
"_id": "abc123",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": true,
"code": "xyz789",
"column": 987,
"content": "abc123",
"contentType": "xyz789",
"contentTypeId": "xyz789",
"description": "xyz789",
"groupId": "xyz789",
"groupName": "abc123",
"isDefinedByErxes": true,
"isRequired": false,
"isVisible": false,
"isVisibleInDetail": true,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"locationOptions": [LocationOption],
"logicAction": "xyz789",
"logics": [Logic],
"name": "abc123",
"objectListConfigs": [ObjectListConfig],
"options": ["abc123"],
"order": 123,
"pageNumber": 123,
"productCategoryId": "abc123",
"products": [Product],
"searchable": false,
"showInCard": true,
"text": "xyz789",
"type": "abc123",
"validation": "abc123"
}
}
}
forgotPassword
formSubmissionsSave
Response
Returns a
Boolean
Example
Query
mutation FormSubmissionsSave(
$contentType: String,
$contentTypeId: String,
$formId: String,
$formSubmissions: JSON
) {
formSubmissionsSave(
contentType: $contentType,
contentTypeId: $contentTypeId,
formId: $formId,
formSubmissions: $formSubmissions
)
}
Variables
{
"contentType": "xyz789",
"contentTypeId": "xyz789",
"formId": "abc123",
"formSubmissions": {}
}
Response
{"data": {"formSubmissionsSave": false}}
formsAdd
Response
Returns a
Form
Example
Query
mutation FormsAdd(
$buttonText: String,
$description: String,
$googleMapApiKey: String,
$numberOfPages: Int,
$title: String,
$type: String!
) {
formsAdd(
buttonText: $buttonText,
description: $description,
googleMapApiKey: $googleMapApiKey,
numberOfPages: $numberOfPages,
title: $title,
type: $type
) {
_id
buttonText
code
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
googleMapApiKey
numberOfPages
title
type
}
}
Variables
{
"buttonText": "xyz789",
"description": "abc123",
"googleMapApiKey": "xyz789",
"numberOfPages": 123,
"title": "xyz789",
"type": "abc123"
}
Response
{
"data": {
"formsAdd": {
"_id": "abc123",
"buttonText": "abc123",
"code": "xyz789",
"createdDate": "2007-12-03",
"createdUser": User,
"createdUserId": "xyz789",
"description": "xyz789",
"fields": [Field],
"googleMapApiKey": "xyz789",
"numberOfPages": 987,
"title": "abc123",
"type": "abc123"
}
}
}
formsEdit
Response
Returns a
Form
Example
Query
mutation FormsEdit(
$_id: String!,
$buttonText: String,
$description: String,
$googleMapApiKey: String,
$numberOfPages: Int,
$title: String,
$type: String!
) {
formsEdit(
_id: $_id,
buttonText: $buttonText,
description: $description,
googleMapApiKey: $googleMapApiKey,
numberOfPages: $numberOfPages,
title: $title,
type: $type
) {
_id
buttonText
code
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
description
fields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
googleMapApiKey
numberOfPages
title
type
}
}
Variables
{
"_id": "abc123",
"buttonText": "xyz789",
"description": "xyz789",
"googleMapApiKey": "xyz789",
"numberOfPages": 123,
"title": "xyz789",
"type": "xyz789"
}
Response
{
"data": {
"formsEdit": {
"_id": "abc123",
"buttonText": "xyz789",
"code": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123",
"description": "abc123",
"fields": [Field],
"googleMapApiKey": "abc123",
"numberOfPages": 987,
"title": "xyz789",
"type": "abc123"
}
}
}
growthHacksAdd
Response
Returns a
GrowthHack
Arguments
| Name | Description |
|---|---|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
confidence -
Int
|
|
description -
String
|
|
ease -
Int
|
|
hackStages -
[String]
|
|
impact -
Int
|
|
labelIds -
[String]
|
|
name -
String
|
|
priority -
String
|
|
proccessId -
String
|
|
reach -
Int
|
|
stageId -
String
|
|
status -
String
|
Example
Query
mutation GrowthHacksAdd(
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$confidence: Int,
$description: String,
$ease: Int,
$hackStages: [String],
$impact: Int,
$labelIds: [String],
$name: String,
$priority: String,
$proccessId: String,
$reach: Int,
$stageId: String,
$status: String
) {
growthHacksAdd(
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
confidence: $confidence,
description: $description,
ease: $ease,
hackStages: $hackStages,
impact: $impact,
labelIds: $labelIds,
name: $name,
priority: $priority,
proccessId: $proccessId,
reach: $reach,
stageId: $stageId,
status: $status
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"aboveItemId": "abc123",
"assignedUserIds": ["xyz789"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"confidence": 123,
"description": "abc123",
"ease": 123,
"hackStages": ["xyz789"],
"impact": 123,
"labelIds": ["abc123"],
"name": "abc123",
"priority": "abc123",
"proccessId": "abc123",
"reach": 123,
"stageId": "abc123",
"status": "xyz789"
}
Response
{
"data": {
"growthHacksAdd": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 987,
"formFields": [Field],
"formId": "abc123",
"formSubmissions": {},
"hackStages": ["abc123"],
"hasNotified": true,
"impact": 123,
"isComplete": false,
"isVoted": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reach": 987,
"reminderMinute": 123,
"score": 987.65,
"scoringType": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789",
"voteCount": 987,
"votedUsers": [User]
}
}
}
growthHacksArchive
Example
Query
mutation GrowthHacksArchive(
$proccessId: String,
$stageId: String!
) {
growthHacksArchive(
proccessId: $proccessId,
stageId: $stageId
)
}
Variables
{
"proccessId": "abc123",
"stageId": "abc123"
}
Response
{"data": {"growthHacksArchive": "xyz789"}}
growthHacksChange
Response
Returns a
GrowthHack
Example
Query
mutation GrowthHacksChange(
$aboveItemId: String,
$destinationStageId: String!,
$itemId: String!,
$proccessId: String,
$sourceStageId: String
) {
growthHacksChange(
aboveItemId: $aboveItemId,
destinationStageId: $destinationStageId,
itemId: $itemId,
proccessId: $proccessId,
sourceStageId: $sourceStageId
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"aboveItemId": "xyz789",
"destinationStageId": "xyz789",
"itemId": "abc123",
"proccessId": "abc123",
"sourceStageId": "xyz789"
}
Response
{
"data": {
"growthHacksChange": {
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 987,
"formFields": [Field],
"formId": "xyz789",
"formSubmissions": {},
"hackStages": ["xyz789"],
"hasNotified": true,
"impact": 123,
"isComplete": true,
"isVoted": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "xyz789",
"reach": 987,
"reminderMinute": 123,
"score": 123.45,
"scoringType": "abc123",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789",
"voteCount": 123,
"votedUsers": [User]
}
}
}
growthHacksCopy
Response
Returns a
GrowthHack
Example
Query
mutation GrowthHacksCopy(
$_id: String!,
$proccessId: String
) {
growthHacksCopy(
_id: $_id,
proccessId: $proccessId
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "abc123",
"proccessId": "xyz789"
}
Response
{
"data": {
"growthHacksCopy": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 123,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 123,
"formFields": [Field],
"formId": "xyz789",
"formSubmissions": {},
"hackStages": ["abc123"],
"hasNotified": false,
"impact": 123,
"isComplete": false,
"isVoted": true,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reach": 123,
"reminderMinute": 987,
"score": 123.45,
"scoringType": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 987,
"votedUsers": [User]
}
}
}
growthHacksEdit
Response
Returns a
GrowthHack
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
confidence -
Int
|
|
description -
String
|
|
ease -
Int
|
|
hackStages -
[String]
|
|
impact -
Int
|
|
name -
String
|
|
priority -
String
|
|
proccessId -
String
|
|
reach -
Int
|
|
stageId -
String
|
|
status -
String
|
Example
Query
mutation GrowthHacksEdit(
$_id: String!,
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$confidence: Int,
$description: String,
$ease: Int,
$hackStages: [String],
$impact: Int,
$name: String,
$priority: String,
$proccessId: String,
$reach: Int,
$stageId: String,
$status: String
) {
growthHacksEdit(
_id: $_id,
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
confidence: $confidence,
description: $description,
ease: $ease,
hackStages: $hackStages,
impact: $impact,
name: $name,
priority: $priority,
proccessId: $proccessId,
reach: $reach,
stageId: $stageId,
status: $status
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "xyz789",
"aboveItemId": "xyz789",
"assignedUserIds": ["abc123"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"confidence": 123,
"description": "abc123",
"ease": 123,
"hackStages": ["xyz789"],
"impact": 123,
"name": "abc123",
"priority": "abc123",
"proccessId": "xyz789",
"reach": 987,
"stageId": "xyz789",
"status": "abc123"
}
Response
{
"data": {
"growthHacksEdit": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 123,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 123,
"formFields": [Field],
"formId": "abc123",
"formSubmissions": {},
"hackStages": ["abc123"],
"hasNotified": true,
"impact": 123,
"isComplete": true,
"isVoted": false,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reach": 987,
"reminderMinute": 123,
"score": 987.65,
"scoringType": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 987,
"votedUsers": [User]
}
}
}
growthHacksRemove
Response
Returns a
GrowthHack
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation GrowthHacksRemove($_id: String!) {
growthHacksRemove(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"growthHacksRemove": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 123,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 123,
"formFields": [Field],
"formId": "abc123",
"formSubmissions": {},
"hackStages": ["xyz789"],
"hasNotified": false,
"impact": 987,
"isComplete": false,
"isVoted": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reach": 987,
"reminderMinute": 987,
"score": 123.45,
"scoringType": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 123,
"votedUsers": [User]
}
}
}
growthHacksVote
Response
Returns a
GrowthHack
Example
Query
mutation GrowthHacksVote(
$_id: String!,
$isVote: Boolean
) {
growthHacksVote(
_id: $_id,
isVote: $isVote
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "xyz789", "isVote": true}
Response
{
"data": {
"growthHacksVote": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"ease": 123,
"formFields": [Field],
"formId": "abc123",
"formSubmissions": {},
"hackStages": ["xyz789"],
"hasNotified": false,
"impact": 123,
"isComplete": true,
"isVoted": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reach": 123,
"reminderMinute": 123,
"score": 123.45,
"scoringType": "xyz789",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 123,
"votedUsers": [User]
}
}
}
growthHacksWatch
Response
Returns a
GrowthHack
Example
Query
mutation GrowthHacksWatch(
$_id: String,
$isAdd: Boolean
) {
growthHacksWatch(
_id: $_id,
isAdd: $isAdd
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
confidence
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
description
ease
formFields {
_id
associatedField {
...FieldFragment
}
associatedFieldId
canHide
code
column
content
contentType
contentTypeId
description
groupId
groupName
isDefinedByErxes
isRequired
isVisible
isVisibleInDetail
lastUpdatedUser {
...UserFragment
}
lastUpdatedUserId
locationOptions {
...LocationOptionFragment
}
logicAction
logics {
...LogicFragment
}
name
objectListConfigs {
...ObjectListConfigFragment
}
options
order
pageNumber
productCategoryId
products {
...ProductFragment
}
searchable
showInCard
text
type
validation
}
formId
formSubmissions
hackStages
hasNotified
impact
isComplete
isVoted
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reach
reminderMinute
score
scoringType
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
voteCount
votedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{"_id": "xyz789", "isAdd": true}
Response
{
"data": {
"growthHacksWatch": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"ease": 987,
"formFields": [Field],
"formId": "xyz789",
"formSubmissions": {},
"hackStages": ["xyz789"],
"hasNotified": true,
"impact": 987,
"isComplete": true,
"isVoted": false,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "xyz789",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reach": 123,
"reminderMinute": 987,
"score": 987.65,
"scoringType": "xyz789",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 123,
"votedUsers": [User]
}
}
}
importHistoriesCancel
importHistoriesCreate
Response
Returns a
JSON
Example
Query
mutation ImportHistoriesCreate(
$associatedContentType: String,
$associatedField: String,
$columnsConfig: JSON,
$contentTypes: [JSON],
$files: JSON,
$importName: String
) {
importHistoriesCreate(
associatedContentType: $associatedContentType,
associatedField: $associatedField,
columnsConfig: $columnsConfig,
contentTypes: $contentTypes,
files: $files,
importName: $importName
)
}
Variables
{
"associatedContentType": "abc123",
"associatedField": "xyz789",
"columnsConfig": {},
"contentTypes": [{}],
"files": {},
"importName": "abc123"
}
Response
{"data": {"importHistoriesCreate": {}}}
importHistoriesRemove
Example
Query
mutation ImportHistoriesRemove(
$_id: String!,
$contentType: String!
) {
importHistoriesRemove(
_id: $_id,
contentType: $contentType
)
}
Variables
{
"_id": "abc123",
"contentType": "abc123"
}
Response
{"data": {"importHistoriesRemove": {}}}
integrationSendMail
Response
Returns a
JSON
Arguments
| Name | Description |
|---|---|
attachments -
[JSON]
|
|
bcc -
[String]
|
|
body -
String
|
|
cc -
[String]
|
|
customerId -
String
|
|
erxesApiId -
String!
|
|
from -
String!
|
|
headerId -
String
|
|
inReplyTo -
String
|
|
kind -
String
|
|
messageId -
String
|
|
references -
[String]
|
|
replyTo -
[String]
|
|
replyToMessageId -
String
|
|
shouldResolve -
Boolean
|
|
subject -
String!
|
|
threadId -
String
|
|
to -
[String]!
|
Example
Query
mutation IntegrationSendMail(
$attachments: [JSON],
$bcc: [String],
$body: String,
$cc: [String],
$customerId: String,
$erxesApiId: String!,
$from: String!,
$headerId: String,
$inReplyTo: String,
$kind: String,
$messageId: String,
$references: [String],
$replyTo: [String],
$replyToMessageId: String,
$shouldResolve: Boolean,
$subject: String!,
$threadId: String,
$to: [String]!
) {
integrationSendMail(
attachments: $attachments,
bcc: $bcc,
body: $body,
cc: $cc,
customerId: $customerId,
erxesApiId: $erxesApiId,
from: $from,
headerId: $headerId,
inReplyTo: $inReplyTo,
kind: $kind,
messageId: $messageId,
references: $references,
replyTo: $replyTo,
replyToMessageId: $replyToMessageId,
shouldResolve: $shouldResolve,
subject: $subject,
threadId: $threadId,
to: $to
)
}
Variables
{
"attachments": [{}],
"bcc": ["xyz789"],
"body": "abc123",
"cc": ["abc123"],
"customerId": "abc123",
"erxesApiId": "xyz789",
"from": "abc123",
"headerId": "abc123",
"inReplyTo": "abc123",
"kind": "xyz789",
"messageId": "abc123",
"references": ["xyz789"],
"replyTo": ["xyz789"],
"replyToMessageId": "xyz789",
"shouldResolve": true,
"subject": "xyz789",
"threadId": "abc123",
"to": ["xyz789"]
}
Response
{"data": {"integrationSendMail": {}}}
integrationsArchive
Response
Returns an
Integration
Example
Query
mutation IntegrationsArchive(
$_id: String!,
$status: Boolean!
) {
integrationsArchive(
_id: $_id,
status: $status
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{"_id": "abc123", "status": false}
Response
{
"data": {
"integrationsArchive": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["abc123"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsCopyLeadIntegration
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation IntegrationsCopyLeadIntegration($_id: String!) {
integrationsCopyLeadIntegration(_id: $_id) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"integrationsCopyLeadIntegration": {
"_id": "xyz789",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["abc123"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsCreateBookingIntegration
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
bookingData -
IntegrationBookingData
|
|
brandId -
String!
|
|
channelIds -
[String]
|
|
formId -
String
|
|
languageCode -
String
|
|
leadData -
IntegrationLeadData
|
|
name -
String!
|
Example
Query
mutation IntegrationsCreateBookingIntegration(
$bookingData: IntegrationBookingData,
$brandId: String!,
$channelIds: [String],
$formId: String,
$languageCode: String,
$leadData: IntegrationLeadData,
$name: String!
) {
integrationsCreateBookingIntegration(
bookingData: $bookingData,
brandId: $brandId,
channelIds: $channelIds,
formId: $formId,
languageCode: $languageCode,
leadData: $leadData,
name: $name
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"bookingData": IntegrationBookingData,
"brandId": "abc123",
"channelIds": ["abc123"],
"formId": "xyz789",
"languageCode": "abc123",
"leadData": IntegrationLeadData,
"name": "abc123"
}
Response
{
"data": {
"integrationsCreateBookingIntegration": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": true,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsCreateExternalIntegration
Response
Returns an
Integration
Example
Query
mutation IntegrationsCreateExternalIntegration(
$accountId: String,
$brandId: String!,
$channelIds: [String],
$data: JSON,
$kind: String!,
$name: String!
) {
integrationsCreateExternalIntegration(
accountId: $accountId,
brandId: $brandId,
channelIds: $channelIds,
data: $data,
kind: $kind,
name: $name
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"accountId": "xyz789",
"brandId": "xyz789",
"channelIds": ["abc123"],
"data": {},
"kind": "abc123",
"name": "abc123"
}
Response
{
"data": {
"integrationsCreateExternalIntegration": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsCreateLeadIntegration
Response
Returns an
Integration
Example
Query
mutation IntegrationsCreateLeadIntegration(
$brandId: String!,
$channelIds: [String],
$departmentIds: [String],
$formId: String!,
$languageCode: String,
$leadData: IntegrationLeadData!,
$name: String!,
$visibility: String
) {
integrationsCreateLeadIntegration(
brandId: $brandId,
channelIds: $channelIds,
departmentIds: $departmentIds,
formId: $formId,
languageCode: $languageCode,
leadData: $leadData,
name: $name,
visibility: $visibility
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"brandId": "abc123",
"channelIds": ["xyz789"],
"departmentIds": ["xyz789"],
"formId": "xyz789",
"languageCode": "abc123",
"leadData": IntegrationLeadData,
"name": "xyz789",
"visibility": "xyz789"
}
Response
{
"data": {
"integrationsCreateLeadIntegration": {
"_id": "xyz789",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "xyz789",
"healthStatus": {},
"isActive": true,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsCreateMessengerIntegration
Response
Returns an
Integration
Example
Query
mutation IntegrationsCreateMessengerIntegration(
$brandId: String!,
$channelIds: [String],
$languageCode: String,
$name: String!
) {
integrationsCreateMessengerIntegration(
brandId: $brandId,
channelIds: $channelIds,
languageCode: $languageCode,
name: $name
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"brandId": "xyz789",
"channelIds": ["xyz789"],
"languageCode": "xyz789",
"name": "xyz789"
}
Response
{
"data": {
"integrationsCreateMessengerIntegration": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsEditBookingIntegration
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
bookingData -
IntegrationBookingData
|
|
brandId -
String!
|
|
channelIds -
[String]
|
|
formId -
String
|
|
languageCode -
String
|
|
leadData -
IntegrationLeadData
|
|
name -
String!
|
Example
Query
mutation IntegrationsEditBookingIntegration(
$_id: String!,
$bookingData: IntegrationBookingData,
$brandId: String!,
$channelIds: [String],
$formId: String,
$languageCode: String,
$leadData: IntegrationLeadData,
$name: String!
) {
integrationsEditBookingIntegration(
_id: $_id,
bookingData: $bookingData,
brandId: $brandId,
channelIds: $channelIds,
formId: $formId,
languageCode: $languageCode,
leadData: $leadData,
name: $name
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"_id": "xyz789",
"bookingData": IntegrationBookingData,
"brandId": "xyz789",
"channelIds": ["abc123"],
"formId": "xyz789",
"languageCode": "xyz789",
"leadData": IntegrationLeadData,
"name": "abc123"
}
Response
{
"data": {
"integrationsEditBookingIntegration": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["abc123"],
"form": Form,
"formId": "xyz789",
"healthStatus": {},
"isActive": false,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "abc123",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsEditCommonFields
Response
Returns an
Integration
Example
Query
mutation IntegrationsEditCommonFields(
$_id: String!,
$brandId: String!,
$channelIds: [String],
$data: JSON,
$name: String!
) {
integrationsEditCommonFields(
_id: $_id,
brandId: $brandId,
channelIds: $channelIds,
data: $data,
name: $name
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"_id": "xyz789",
"brandId": "abc123",
"channelIds": ["xyz789"],
"data": {},
"name": "abc123"
}
Response
{
"data": {
"integrationsEditCommonFields": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["abc123"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": true,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsEditLeadIntegration
Response
Returns an
Integration
Example
Query
mutation IntegrationsEditLeadIntegration(
$_id: String!,
$brandId: String!,
$channelIds: [String],
$departmentIds: [String],
$formId: String!,
$languageCode: String,
$leadData: IntegrationLeadData!,
$name: String!,
$visibility: String
) {
integrationsEditLeadIntegration(
_id: $_id,
brandId: $brandId,
channelIds: $channelIds,
departmentIds: $departmentIds,
formId: $formId,
languageCode: $languageCode,
leadData: $leadData,
name: $name,
visibility: $visibility
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"_id": "abc123",
"brandId": "xyz789",
"channelIds": ["xyz789"],
"departmentIds": ["abc123"],
"formId": "xyz789",
"languageCode": "abc123",
"leadData": IntegrationLeadData,
"name": "abc123",
"visibility": "abc123"
}
Response
{
"data": {
"integrationsEditLeadIntegration": {
"_id": "xyz789",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["abc123"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": false,
"kind": "xyz789",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsEditMessengerIntegration
Response
Returns an
Integration
Example
Query
mutation IntegrationsEditMessengerIntegration(
$_id: String!,
$brandId: String!,
$channelIds: [String],
$languageCode: String,
$name: String!
) {
integrationsEditMessengerIntegration(
_id: $_id,
brandId: $brandId,
channelIds: $channelIds,
languageCode: $languageCode,
name: $name
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"_id": "xyz789",
"brandId": "abc123",
"channelIds": ["abc123"],
"languageCode": "xyz789",
"name": "abc123"
}
Response
{
"data": {
"integrationsEditMessengerIntegration": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "xyz789",
"healthStatus": {},
"isActive": false,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "abc123",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsRemove
integrationsRemoveAccount
integrationsRepair
integrationsSaveMessengerAppearanceData
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
uiOptions -
MessengerUiOptions
|
Example
Query
mutation IntegrationsSaveMessengerAppearanceData(
$_id: String!,
$uiOptions: MessengerUiOptions
) {
integrationsSaveMessengerAppearanceData(
_id: $_id,
uiOptions: $uiOptions
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"_id": "xyz789",
"uiOptions": MessengerUiOptions
}
Response
{
"data": {
"integrationsSaveMessengerAppearanceData": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["abc123"],
"form": Form,
"formId": "xyz789",
"healthStatus": {},
"isActive": true,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsSaveMessengerConfigs
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
messengerData -
IntegrationMessengerData
|
Example
Query
mutation IntegrationsSaveMessengerConfigs(
$_id: String!,
$messengerData: IntegrationMessengerData
) {
integrationsSaveMessengerConfigs(
_id: $_id,
messengerData: $messengerData
) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{
"_id": "xyz789",
"messengerData": IntegrationMessengerData
}
Response
{
"data": {
"integrationsSaveMessengerConfigs": {
"_id": "xyz789",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "abc123",
"healthStatus": {},
"isActive": true,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
integrationsSendSms
Response
Returns a
JSON
Example
Query
mutation IntegrationsSendSms(
$content: String!,
$integrationId: String!,
$to: String!
) {
integrationsSendSms(
content: $content,
integrationId: $integrationId,
to: $to
)
}
Variables
{
"content": "xyz789",
"integrationId": "abc123",
"to": "xyz789"
}
Response
{"data": {"integrationsSendSms": {}}}
integrationsUpdateConfigs
internalNotesAdd
Response
Returns an
InternalNote
Example
Query
mutation InternalNotesAdd(
$content: String,
$contentType: String!,
$contentTypeId: String,
$mentionedUserIds: [String]
) {
internalNotesAdd(
content: $content,
contentType: $contentType,
contentTypeId: $contentTypeId,
mentionedUserIds: $mentionedUserIds
) {
_id
content
contentType
contentTypeId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
}
}
Variables
{
"content": "xyz789",
"contentType": "xyz789",
"contentTypeId": "abc123",
"mentionedUserIds": ["abc123"]
}
Response
{
"data": {
"internalNotesAdd": {
"_id": "abc123",
"content": "xyz789",
"contentType": "xyz789",
"contentTypeId": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123"
}
}
}
internalNotesEdit
Response
Returns an
InternalNote
Example
Query
mutation InternalNotesEdit(
$_id: String!,
$content: String,
$mentionedUserIds: [String]
) {
internalNotesEdit(
_id: $_id,
content: $content,
mentionedUserIds: $mentionedUserIds
) {
_id
content
contentType
contentTypeId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
}
}
Variables
{
"_id": "xyz789",
"content": "abc123",
"mentionedUserIds": ["abc123"]
}
Response
{
"data": {
"internalNotesEdit": {
"_id": "abc123",
"content": "abc123",
"contentType": "abc123",
"contentTypeId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"createdUserId": "abc123"
}
}
}
internalNotesRemove
Response
Returns an
InternalNote
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation InternalNotesRemove($_id: String!) {
internalNotesRemove(_id: $_id) {
_id
content
contentType
contentTypeId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdUserId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"internalNotesRemove": {
"_id": "xyz789",
"content": "abc123",
"contentType": "xyz789",
"contentTypeId": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"createdUserId": "xyz789"
}
}
}
knowledgeBaseArticlesAdd
Response
Returns a
KnowledgeBaseArticle
Arguments
| Name | Description |
|---|---|
doc -
KnowledgeBaseArticleDoc!
|
Example
Query
mutation KnowledgeBaseArticlesAdd($doc: KnowledgeBaseArticleDoc!) {
knowledgeBaseArticlesAdd(doc: $doc) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{"doc": KnowledgeBaseArticleDoc}
Response
{
"data": {
"knowledgeBaseArticlesAdd": {
"_id": "abc123",
"attachments": [Attachment],
"categoryId": "abc123",
"content": "xyz789",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"reactionChoices": ["abc123"],
"reactionCounts": {},
"status": "xyz789",
"summary": "xyz789",
"title": "abc123",
"topicId": "xyz789",
"viewCount": 987
}
}
}
knowledgeBaseArticlesEdit
Response
Returns a
KnowledgeBaseArticle
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
doc -
KnowledgeBaseArticleDoc!
|
Example
Query
mutation KnowledgeBaseArticlesEdit(
$_id: String!,
$doc: KnowledgeBaseArticleDoc!
) {
knowledgeBaseArticlesEdit(
_id: $_id,
doc: $doc
) {
_id
attachments {
duration
name
size
type
url
}
categoryId
content
createdBy
createdDate
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
image {
duration
name
size
type
url
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
}
Variables
{
"_id": "abc123",
"doc": KnowledgeBaseArticleDoc
}
Response
{
"data": {
"knowledgeBaseArticlesEdit": {
"_id": "xyz789",
"attachments": [Attachment],
"categoryId": "abc123",
"content": "xyz789",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"reactionChoices": ["xyz789"],
"reactionCounts": {},
"status": "abc123",
"summary": "xyz789",
"title": "abc123",
"topicId": "xyz789",
"viewCount": 123
}
}
}
knowledgeBaseArticlesRemove
knowledgeBaseCategoriesAdd
Response
Returns a
KnowledgeBaseCategory
Arguments
| Name | Description |
|---|---|
doc -
KnowledgeBaseCategoryDoc!
|
Example
Query
mutation KnowledgeBaseCategoriesAdd($doc: KnowledgeBaseCategoryDoc!) {
knowledgeBaseCategoriesAdd(doc: $doc) {
_id
articles {
_id
attachments {
...AttachmentFragment
}
categoryId
content
createdBy
createdDate
createdUser {
...UserFragment
}
image {
...AttachmentFragment
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
authors {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdBy
createdDate
description
firstTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
}
Variables
{"doc": KnowledgeBaseCategoryDoc}
Response
{
"data": {
"knowledgeBaseCategoriesAdd": {
"_id": "abc123",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"description": "abc123",
"firstTopic": KnowledgeBaseTopic,
"icon": "abc123",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"numOfArticles": 123.45,
"parentCategoryId": "abc123",
"title": "xyz789"
}
}
}
knowledgeBaseCategoriesEdit
Response
Returns a
KnowledgeBaseCategory
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
doc -
KnowledgeBaseCategoryDoc!
|
Example
Query
mutation KnowledgeBaseCategoriesEdit(
$_id: String!,
$doc: KnowledgeBaseCategoryDoc!
) {
knowledgeBaseCategoriesEdit(
_id: $_id,
doc: $doc
) {
_id
articles {
_id
attachments {
...AttachmentFragment
}
categoryId
content
createdBy
createdDate
createdUser {
...UserFragment
}
image {
...AttachmentFragment
}
modifiedBy
modifiedDate
reactionChoices
reactionCounts
status
summary
title
topicId
viewCount
}
authors {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
createdBy
createdDate
description
firstTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
}
Variables
{
"_id": "xyz789",
"doc": KnowledgeBaseCategoryDoc
}
Response
{
"data": {
"knowledgeBaseCategoriesEdit": {
"_id": "abc123",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "abc123",
"firstTopic": KnowledgeBaseTopic,
"icon": "abc123",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"numOfArticles": 123.45,
"parentCategoryId": "xyz789",
"title": "xyz789"
}
}
}
knowledgeBaseCategoriesRemove
knowledgeBaseTopicsAdd
Response
Returns a
KnowledgeBaseTopic
Arguments
| Name | Description |
|---|---|
doc -
KnowledgeBaseTopicDoc!
|
Example
Query
mutation KnowledgeBaseTopicsAdd($doc: KnowledgeBaseTopicDoc!) {
knowledgeBaseTopicsAdd(doc: $doc) {
_id
backgroundImage
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
categories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
childrens {
...KnowledgeBaseCategoryFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
title
}
}
Variables
{"doc": KnowledgeBaseTopicDoc}
Response
{
"data": {
"knowledgeBaseTopicsAdd": {
"_id": "abc123",
"backgroundImage": "abc123",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "xyz789",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "abc123",
"languageCode": "abc123",
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "abc123"
}
}
}
knowledgeBaseTopicsEdit
Response
Returns a
KnowledgeBaseTopic
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
doc -
KnowledgeBaseTopicDoc!
|
Example
Query
mutation KnowledgeBaseTopicsEdit(
$_id: String!,
$doc: KnowledgeBaseTopicDoc!
) {
knowledgeBaseTopicsEdit(
_id: $_id,
doc: $doc
) {
_id
backgroundImage
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
categories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
_id
articles {
...KnowledgeBaseArticleFragment
}
authors {
...UserFragment
}
childrens {
...KnowledgeBaseCategoryFragment
}
createdBy
createdDate
description
firstTopic {
...KnowledgeBaseTopicFragment
}
icon
modifiedBy
modifiedDate
numOfArticles
parentCategoryId
title
}
title
}
}
Variables
{
"_id": "xyz789",
"doc": KnowledgeBaseTopicDoc
}
Response
{
"data": {
"knowledgeBaseTopicsEdit": {
"_id": "xyz789",
"backgroundImage": "abc123",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "xyz789",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "xyz789",
"languageCode": "abc123",
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "xyz789"
}
}
}
knowledgeBaseTopicsRemove
login
Response
Returns a
String
Example
Query
mutation Login(
$deviceToken: String,
$email: String!,
$password: String!
) {
login(
deviceToken: $deviceToken,
email: $email,
password: $password
)
}
Variables
{
"deviceToken": "xyz789",
"email": "abc123",
"password": "xyz789"
}
Response
{"data": {"login": "xyz789"}}
logout
Response
Returns a
String
Example
Query
mutation Logout {
logout
}
Response
{"data": {"logout": "abc123"}}
lotteriesAdd
Response
Returns a
Lottery
Example
Query
mutation LotteriesAdd(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$status: String,
$usedAt: Date
) {
lotteriesAdd(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
status: $status,
usedAt: $usedAt
) {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "abc123",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"lotteriesAdd": {
"_id": "abc123",
"awardId": "xyz789",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"number": "abc123",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "xyz789"
}
}
}
lotteriesEdit
Response
Returns a
Lottery
Example
Query
mutation LotteriesEdit(
$_id: String!,
$campaignId: String,
$ownerId: String,
$ownerType: String,
$status: String,
$usedAt: Date
) {
lotteriesEdit(
_id: $_id,
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
status: $status,
usedAt: $usedAt
) {
_id
awardId
campaign
campaignId
createdAt
number
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"_id": "xyz789",
"campaignId": "xyz789",
"ownerId": "abc123",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"lotteriesEdit": {
"_id": "xyz789",
"awardId": "xyz789",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"number": "xyz789",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "abc123"
}
}
}
lotteriesRemove
lotteryCampaignsAdd
Response
Returns a
LotteryCampaign
Example
Query
mutation LotteryCampaignsAdd(
$attachment: AttachmentInput,
$awards: JSON,
$buyScore: Float,
$description: String,
$endDate: Date,
$finishDateOfUse: Date,
$numberFormat: String,
$startDate: Date,
$status: String,
$title: String
) {
lotteryCampaignsAdd(
attachment: $attachment,
awards: $awards,
buyScore: $buyScore,
description: $description,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
numberFormat: $numberFormat,
startDate: $startDate,
status: $status,
title: $title
) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
lotteriesCount
modifiedAt
modifiedBy
numberFormat
startDate
status
title
}
}
Variables
{
"attachment": AttachmentInput,
"awards": {},
"buyScore": 123.45,
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"numberFormat": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"title": "xyz789"
}
Response
{
"data": {
"lotteryCampaignsAdd": {
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteriesCount": 987,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"numberFormat": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
}
}
lotteryCampaignsEdit
Response
Returns a
LotteryCampaign
Example
Query
mutation LotteryCampaignsEdit(
$_id: String!,
$attachment: AttachmentInput,
$awards: JSON,
$buyScore: Float,
$description: String,
$endDate: Date,
$finishDateOfUse: Date,
$numberFormat: String,
$startDate: Date,
$status: String,
$title: String
) {
lotteryCampaignsEdit(
_id: $_id,
attachment: $attachment,
awards: $awards,
buyScore: $buyScore,
description: $description,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
numberFormat: $numberFormat,
startDate: $startDate,
status: $status,
title: $title
) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
lotteriesCount
modifiedAt
modifiedBy
numberFormat
startDate
status
title
}
}
Variables
{
"_id": "abc123",
"attachment": AttachmentInput,
"awards": {},
"buyScore": 987.65,
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"numberFormat": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
Response
{
"data": {
"lotteryCampaignsEdit": {
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"buyScore": 123.45,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteriesCount": 123,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"numberFormat": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
}
}
lotteryCampaignsRemove
loyaltyConfigsUpdate
messengerAppSave
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
integrationId -
String!
|
|
messengerApps -
MessengerAppsInput
|
Example
Query
mutation MessengerAppSave(
$integrationId: String!,
$messengerApps: MessengerAppsInput
) {
messengerAppSave(
integrationId: $integrationId,
messengerApps: $messengerApps
)
}
Variables
{
"integrationId": "abc123",
"messengerApps": MessengerAppsInput
}
Response
{"data": {"messengerAppSave": "abc123"}}
neighborItemCreate
Response
Returns a
JSON
Arguments
| Name | Description |
|---|---|
_id -
String
|
|
busStopData -
CommonInput
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
districtTownData -
DistrictTownInput
|
|
envInfoData -
EnvInfoInput
|
|
hospitalData -
CommonInput
|
|
khorooData -
KhorooInput
|
|
kindergardenData -
SchoolInput
|
|
name -
String
|
|
parkingData -
CommonInput
|
|
pharmacyData -
CommonInput
|
|
schoolData -
SchoolInput
|
|
sohData -
SohInput
|
|
type -
String
|
|
universityData -
UniversityInput
|
Example
Query
mutation NeighborItemCreate(
$_id: String,
$busStopData: CommonInput,
$createdAt: Date,
$createdBy: String,
$districtTownData: DistrictTownInput,
$envInfoData: EnvInfoInput,
$hospitalData: CommonInput,
$khorooData: KhorooInput,
$kindergardenData: SchoolInput,
$name: String,
$parkingData: CommonInput,
$pharmacyData: CommonInput,
$schoolData: SchoolInput,
$sohData: SohInput,
$type: String,
$universityData: UniversityInput
) {
neighborItemCreate(
_id: $_id,
busStopData: $busStopData,
createdAt: $createdAt,
createdBy: $createdBy,
districtTownData: $districtTownData,
envInfoData: $envInfoData,
hospitalData: $hospitalData,
khorooData: $khorooData,
kindergardenData: $kindergardenData,
name: $name,
parkingData: $parkingData,
pharmacyData: $pharmacyData,
schoolData: $schoolData,
sohData: $sohData,
type: $type,
universityData: $universityData
)
}
Variables
{
"_id": "xyz789",
"busStopData": CommonInput,
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"districtTownData": DistrictTownInput,
"envInfoData": EnvInfoInput,
"hospitalData": CommonInput,
"khorooData": KhorooInput,
"kindergardenData": SchoolInput,
"name": "xyz789",
"parkingData": CommonInput,
"pharmacyData": CommonInput,
"schoolData": SchoolInput,
"sohData": SohInput,
"type": "xyz789",
"universityData": UniversityInput
}
Response
{"data": {"neighborItemCreate": {}}}
neighborItemEdit
Response
Returns a
JSON
Arguments
| Name | Description |
|---|---|
_id -
String
|
|
busStopData -
CommonInput
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
districtTownData -
DistrictTownInput
|
|
envInfoData -
EnvInfoInput
|
|
hospitalData -
CommonInput
|
|
khorooData -
KhorooInput
|
|
kindergardenData -
SchoolInput
|
|
name -
String
|
|
parkingData -
CommonInput
|
|
pharmacyData -
CommonInput
|
|
schoolData -
SchoolInput
|
|
sohData -
SohInput
|
|
type -
String
|
|
universityData -
UniversityInput
|
Example
Query
mutation NeighborItemEdit(
$_id: String,
$busStopData: CommonInput,
$createdAt: Date,
$createdBy: String,
$districtTownData: DistrictTownInput,
$envInfoData: EnvInfoInput,
$hospitalData: CommonInput,
$khorooData: KhorooInput,
$kindergardenData: SchoolInput,
$name: String,
$parkingData: CommonInput,
$pharmacyData: CommonInput,
$schoolData: SchoolInput,
$sohData: SohInput,
$type: String,
$universityData: UniversityInput
) {
neighborItemEdit(
_id: $_id,
busStopData: $busStopData,
createdAt: $createdAt,
createdBy: $createdBy,
districtTownData: $districtTownData,
envInfoData: $envInfoData,
hospitalData: $hospitalData,
khorooData: $khorooData,
kindergardenData: $kindergardenData,
name: $name,
parkingData: $parkingData,
pharmacyData: $pharmacyData,
schoolData: $schoolData,
sohData: $sohData,
type: $type,
universityData: $universityData
)
}
Variables
{
"_id": "abc123",
"busStopData": CommonInput,
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"districtTownData": DistrictTownInput,
"envInfoData": EnvInfoInput,
"hospitalData": CommonInput,
"khorooData": KhorooInput,
"kindergardenData": SchoolInput,
"name": "abc123",
"parkingData": CommonInput,
"pharmacyData": CommonInput,
"schoolData": SchoolInput,
"sohData": SohInput,
"type": "xyz789",
"universityData": UniversityInput
}
Response
{"data": {"neighborItemEdit": {}}}
neighborItemRemove
neighborRemove
Response
Returns a
Neighbor
Example
Query
mutation NeighborRemove(
$data: JSON,
$productCategoryId: String,
$rate: JSON
) {
neighborRemove(
data: $data,
productCategoryId: $productCategoryId,
rate: $rate
) {
_id
data
info
productCategoryId
rate
}
}
Variables
{
"data": {},
"productCategoryId": "abc123",
"rate": {}
}
Response
{
"data": {
"neighborRemove": {
"_id": "abc123",
"data": {},
"info": {},
"productCategoryId": "abc123",
"rate": {}
}
}
}
neighborSave
Response
Returns a
Neighbor
Example
Query
mutation NeighborSave(
$data: JSON,
$productCategoryId: String,
$rate: JSON
) {
neighborSave(
data: $data,
productCategoryId: $productCategoryId,
rate: $rate
) {
_id
data
info
productCategoryId
rate
}
}
Variables
{
"data": {},
"productCategoryId": "abc123",
"rate": {}
}
Response
{
"data": {
"neighborSave": {
"_id": "xyz789",
"data": {},
"info": {},
"productCategoryId": "xyz789",
"rate": {}
}
}
}
notificationsMarkAsRead
Example
Query
mutation NotificationsMarkAsRead(
$_ids: [String],
$contentTypeId: String
) {
notificationsMarkAsRead(
_ids: $_ids,
contentTypeId: $contentTypeId
)
}
Variables
{
"_ids": ["abc123"],
"contentTypeId": "xyz789"
}
Response
{"data": {"notificationsMarkAsRead": {}}}
notificationsSaveConfig
Response
Returns a
NotificationConfiguration
Example
Query
mutation NotificationsSaveConfig(
$isAllowed: Boolean,
$notifType: String!
) {
notificationsSaveConfig(
isAllowed: $isAllowed,
notifType: $notifType
) {
_id
isAllowed
notifType
user
}
}
Variables
{"isAllowed": true, "notifType": "abc123"}
Response
{
"data": {
"notificationsSaveConfig": {
"_id": "xyz789",
"isAllowed": false,
"notifType": "abc123",
"user": "abc123"
}
}
}
notificationsShow
Response
Returns a
String
Example
Query
mutation NotificationsShow {
notificationsShow
}
Response
{"data": {"notificationsShow": "abc123"}}
onboardingCheckStatus
Response
Returns a
String
Example
Query
mutation OnboardingCheckStatus {
onboardingCheckStatus
}
Response
{
"data": {
"onboardingCheckStatus": "abc123"
}
}
onboardingCompleteShowStep
onboardingForceComplete
Response
Returns a
JSON
Example
Query
mutation OnboardingForceComplete {
onboardingForceComplete
}
Response
{"data": {"onboardingForceComplete": {}}}
permissionsAdd
Response
Returns
[Permission]
Arguments
| Name | Description |
|---|---|
actions -
[String!]!
|
|
allowed -
Boolean
|
|
groupIds -
[String!]
|
|
module -
String!
|
|
userIds -
[String!]
|
Example
Query
mutation PermissionsAdd(
$actions: [String!]!,
$allowed: Boolean,
$groupIds: [String!],
$module: String!,
$userIds: [String!]
) {
permissionsAdd(
actions: $actions,
allowed: $allowed,
groupIds: $groupIds,
module: $module,
userIds: $userIds
) {
_id
action
allowed
group {
_id
description
memberIds
members {
...UserFragment
}
name
}
groupId
module
requiredActions
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
}
}
Variables
{
"actions": ["abc123"],
"allowed": true,
"groupIds": ["abc123"],
"module": "xyz789",
"userIds": ["abc123"]
}
Response
{
"data": {
"permissionsAdd": [
{
"_id": "xyz789",
"action": "xyz789",
"allowed": false,
"group": UsersGroup,
"groupId": "abc123",
"module": "abc123",
"requiredActions": ["xyz789"],
"user": User,
"userId": "xyz789"
}
]
}
}
permissionsFix
Response
Returns
[String]
Example
Query
mutation PermissionsFix {
permissionsFix
}
Response
{"data": {"permissionsFix": ["xyz789"]}}
permissionsRemove
pipelineLabelsAdd
Response
Returns a
PipelineLabel
Example
Query
mutation PipelineLabelsAdd(
$colorCode: String!,
$name: String!,
$pipelineId: String!
) {
pipelineLabelsAdd(
colorCode: $colorCode,
name: $name,
pipelineId: $pipelineId
) {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
}
Variables
{
"colorCode": "abc123",
"name": "abc123",
"pipelineId": "abc123"
}
Response
{
"data": {
"pipelineLabelsAdd": {
"_id": "xyz789",
"colorCode": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"name": "abc123",
"pipelineId": "abc123"
}
}
}
pipelineLabelsEdit
Response
Returns a
PipelineLabel
Example
Query
mutation PipelineLabelsEdit(
$_id: String!,
$colorCode: String!,
$name: String!,
$pipelineId: String!
) {
pipelineLabelsEdit(
_id: $_id,
colorCode: $colorCode,
name: $name,
pipelineId: $pipelineId
) {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
}
Variables
{
"_id": "abc123",
"colorCode": "xyz789",
"name": "xyz789",
"pipelineId": "abc123"
}
Response
{
"data": {
"pipelineLabelsEdit": {
"_id": "abc123",
"colorCode": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"name": "xyz789",
"pipelineId": "xyz789"
}
}
}
pipelineLabelsLabel
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
labelIds -
[String!]!
|
|
pipelineId -
String!
|
|
targetId -
String!
|
Example
Query
mutation PipelineLabelsLabel(
$labelIds: [String!]!,
$pipelineId: String!,
$targetId: String!
) {
pipelineLabelsLabel(
labelIds: $labelIds,
pipelineId: $pipelineId,
targetId: $targetId
)
}
Variables
{
"labelIds": ["abc123"],
"pipelineId": "xyz789",
"targetId": "abc123"
}
Response
{"data": {"pipelineLabelsLabel": "xyz789"}}
pipelineLabelsRemove
pipelineTemplatesAdd
Response
Returns a
PipelineTemplate
Arguments
| Name | Description |
|---|---|
description -
String
|
|
name -
String!
|
|
stages -
[PipelineTemplateStageInput]
|
|
type -
String!
|
Example
Query
mutation PipelineTemplatesAdd(
$description: String,
$name: String!,
$stages: [PipelineTemplateStageInput],
$type: String!
) {
pipelineTemplatesAdd(
description: $description,
name: $name,
stages: $stages,
type: $type
) {
_id
createdAt
createdBy
description
isDefinedByErxes
name
stages {
_id
formId
name
order
}
type
}
}
Variables
{
"description": "xyz789",
"name": "abc123",
"stages": [PipelineTemplateStageInput],
"type": "abc123"
}
Response
{
"data": {
"pipelineTemplatesAdd": {
"_id": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"isDefinedByErxes": true,
"name": "abc123",
"stages": [PipelineTemplateStage],
"type": "xyz789"
}
}
}
pipelineTemplatesDuplicate
Response
Returns a
PipelineTemplate
Arguments
| Name | Description |
|---|---|
_id -
String!
|
Example
Query
mutation PipelineTemplatesDuplicate($_id: String!) {
pipelineTemplatesDuplicate(_id: $_id) {
_id
createdAt
createdBy
description
isDefinedByErxes
name
stages {
_id
formId
name
order
}
type
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"pipelineTemplatesDuplicate": {
"_id": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"isDefinedByErxes": false,
"name": "abc123",
"stages": [PipelineTemplateStage],
"type": "xyz789"
}
}
}
pipelineTemplatesEdit
Response
Returns a
PipelineTemplate
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
description -
String
|
|
name -
String!
|
|
stages -
[PipelineTemplateStageInput]
|
|
type -
String!
|
Example
Query
mutation PipelineTemplatesEdit(
$_id: String!,
$description: String,
$name: String!,
$stages: [PipelineTemplateStageInput],
$type: String!
) {
pipelineTemplatesEdit(
_id: $_id,
description: $description,
name: $name,
stages: $stages,
type: $type
) {
_id
createdAt
createdBy
description
isDefinedByErxes
name
stages {
_id
formId
name
order
}
type
}
}
Variables
{
"_id": "abc123",
"description": "abc123",
"name": "abc123",
"stages": [PipelineTemplateStageInput],
"type": "xyz789"
}
Response
{
"data": {
"pipelineTemplatesEdit": {
"_id": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"isDefinedByErxes": false,
"name": "abc123",
"stages": [PipelineTemplateStage],
"type": "xyz789"
}
}
}
pipelineTemplatesRemove
pipelinesAdd
Response
Returns a
Pipeline
Arguments
| Name | Description |
|---|---|
bgColor -
String
|
|
boardId -
String!
|
|
departmentIds -
[String]
|
|
endDate -
Date
|
|
excludeCheckUserIds -
[String]
|
|
hackScoringType -
String
|
|
isCheckDepartment -
Boolean
|
|
isCheckUser -
Boolean
|
|
memberIds -
[String]
|
|
metric -
String
|
|
name -
String!
|
|
numberConfig -
String
|
|
numberSize -
String
|
|
stages -
JSON
|
|
startDate -
Date
|
|
templateId -
String
|
|
type -
String!
|
|
visibility -
String!
|
Example
Query
mutation PipelinesAdd(
$bgColor: String,
$boardId: String!,
$departmentIds: [String],
$endDate: Date,
$excludeCheckUserIds: [String],
$hackScoringType: String,
$isCheckDepartment: Boolean,
$isCheckUser: Boolean,
$memberIds: [String],
$metric: String,
$name: String!,
$numberConfig: String,
$numberSize: String,
$stages: JSON,
$startDate: Date,
$templateId: String,
$type: String!,
$visibility: String!
) {
pipelinesAdd(
bgColor: $bgColor,
boardId: $boardId,
departmentIds: $departmentIds,
endDate: $endDate,
excludeCheckUserIds: $excludeCheckUserIds,
hackScoringType: $hackScoringType,
isCheckDepartment: $isCheckDepartment,
isCheckUser: $isCheckUser,
memberIds: $memberIds,
metric: $metric,
name: $name,
numberConfig: $numberConfig,
numberSize: $numberSize,
stages: $stages,
startDate: $startDate,
templateId: $templateId,
type: $type,
visibility: $visibility
) {
_id
bgColor
boardId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
}
Variables
{
"bgColor": "xyz789",
"boardId": "abc123",
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["abc123"],
"hackScoringType": "xyz789",
"isCheckDepartment": false,
"isCheckUser": false,
"memberIds": ["abc123"],
"metric": "abc123",
"name": "abc123",
"numberConfig": "xyz789",
"numberSize": "abc123",
"stages": {},
"startDate": "2007-12-03",
"templateId": "xyz789",
"type": "abc123",
"visibility": "xyz789"
}
Response
{
"data": {
"pipelinesAdd": {
"_id": "abc123",
"bgColor": "xyz789",
"boardId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["abc123"],
"hackScoringType": "abc123",
"isCheckDepartment": true,
"isCheckUser": true,
"isWatched": false,
"itemsTotalCount": 123,
"memberIds": ["xyz789"],
"members": [User],
"metric": "xyz789",
"name": "xyz789",
"numberConfig": "abc123",
"numberSize": "xyz789",
"order": 987,
"startDate": "2007-12-03",
"state": "abc123",
"status": "xyz789",
"templateId": "xyz789",
"type": "xyz789",
"userId": "xyz789",
"visibility": "xyz789"
}
}
}
pipelinesArchive
pipelinesCopied
pipelinesEdit
Response
Returns a
Pipeline
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
bgColor -
String
|
|
boardId -
String!
|
|
departmentIds -
[String]
|
|
endDate -
Date
|
|
excludeCheckUserIds -
[String]
|
|
hackScoringType -
String
|
|
isCheckDepartment -
Boolean
|
|
isCheckUser -
Boolean
|
|
memberIds -
[String]
|
|
metric -
String
|
|
name -
String!
|
|
numberConfig -
String
|
|
numberSize -
String
|
|
stages -
JSON
|
|
startDate -
Date
|
|
templateId -
String
|
|
type -
String!
|
|
visibility -
String!
|
Example
Query
mutation PipelinesEdit(
$_id: String!,
$bgColor: String,
$boardId: String!,
$departmentIds: [String],
$endDate: Date,
$excludeCheckUserIds: [String],
$hackScoringType: String,
$isCheckDepartment: Boolean,
$isCheckUser: Boolean,
$memberIds: [String],
$metric: String,
$name: String!,
$numberConfig: String,
$numberSize: String,
$stages: JSON,
$startDate: Date,
$templateId: String,
$type: String!,
$visibility: String!
) {
pipelinesEdit(
_id: $_id,
bgColor: $bgColor,
boardId: $boardId,
departmentIds: $departmentIds,
endDate: $endDate,
excludeCheckUserIds: $excludeCheckUserIds,
hackScoringType: $hackScoringType,
isCheckDepartment: $isCheckDepartment,
isCheckUser: $isCheckUser,
memberIds: $memberIds,
metric: $metric,
name: $name,
numberConfig: $numberConfig,
numberSize: $numberSize,
stages: $stages,
startDate: $startDate,
templateId: $templateId,
type: $type,
visibility: $visibility
) {
_id
bgColor
boardId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
}
Variables
{
"_id": "abc123",
"bgColor": "xyz789",
"boardId": "xyz789",
"departmentIds": ["abc123"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["xyz789"],
"hackScoringType": "abc123",
"isCheckDepartment": false,
"isCheckUser": true,
"memberIds": ["xyz789"],
"metric": "abc123",
"name": "abc123",
"numberConfig": "xyz789",
"numberSize": "xyz789",
"stages": {},
"startDate": "2007-12-03",
"templateId": "xyz789",
"type": "xyz789",
"visibility": "abc123"
}
Response
{
"data": {
"pipelinesEdit": {
"_id": "xyz789",
"bgColor": "abc123",
"boardId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["abc123"],
"hackScoringType": "xyz789",
"isCheckDepartment": false,
"isCheckUser": false,
"isWatched": false,
"itemsTotalCount": 987,
"memberIds": ["abc123"],
"members": [User],
"metric": "abc123",
"name": "xyz789",
"numberConfig": "xyz789",
"numberSize": "abc123",
"order": 987,
"startDate": "2007-12-03",
"state": "abc123",
"status": "abc123",
"templateId": "xyz789",
"type": "abc123",
"userId": "xyz789",
"visibility": "xyz789"
}
}
}
pipelinesRemove
pipelinesUpdateOrder
Response
Returns
[Pipeline]
Arguments
| Name | Description |
|---|---|
orders -
[OrderItem]
|
Example
Query
mutation PipelinesUpdateOrder($orders: [OrderItem]) {
pipelinesUpdateOrder(orders: $orders) {
_id
bgColor
boardId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
}
Variables
{"orders": [OrderItem]}
Response
{
"data": {
"pipelinesUpdateOrder": [
{
"_id": "xyz789",
"bgColor": "abc123",
"boardId": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["xyz789"],
"hackScoringType": "xyz789",
"isCheckDepartment": true,
"isCheckUser": true,
"isWatched": true,
"itemsTotalCount": 987,
"memberIds": ["abc123"],
"members": [User],
"metric": "abc123",
"name": "xyz789",
"numberConfig": "xyz789",
"numberSize": "abc123",
"order": 987,
"startDate": "2007-12-03",
"state": "abc123",
"status": "abc123",
"templateId": "abc123",
"type": "abc123",
"userId": "xyz789",
"visibility": "abc123"
}
]
}
}
pipelinesWatch
Example
Query
mutation PipelinesWatch(
$_id: String!,
$isAdd: Boolean,
$type: String!
) {
pipelinesWatch(
_id: $_id,
isAdd: $isAdd,
type: $type
) {
_id
bgColor
boardId
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
}
Variables
{
"_id": "xyz789",
"isAdd": false,
"type": "abc123"
}
Response
{
"data": {
"pipelinesWatch": {
"_id": "abc123",
"bgColor": "xyz789",
"boardId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["xyz789"],
"hackScoringType": "xyz789",
"isCheckDepartment": true,
"isCheckUser": true,
"isWatched": false,
"itemsTotalCount": 987,
"memberIds": ["xyz789"],
"members": [User],
"metric": "xyz789",
"name": "abc123",
"numberConfig": "xyz789",
"numberSize": "abc123",
"order": 123,
"startDate": "2007-12-03",
"state": "xyz789",
"status": "xyz789",
"templateId": "abc123",
"type": "abc123",
"userId": "abc123",
"visibility": "xyz789"
}
}
}
productCategoriesAdd
Response
Returns a
ProductCategory
Example
Query
mutation ProductCategoriesAdd(
$attachment: AttachmentInput,
$code: String!,
$description: String,
$name: String!,
$parentId: String,
$status: String
) {
productCategoriesAdd(
attachment: $attachment,
code: $code,
description: $description,
name: $name,
parentId: $parentId,
status: $status
) {
_id
attachment {
duration
name
size
type
url
}
code
description
isRoot
name
order
parentId
productCount
status
}
}
Variables
{
"attachment": AttachmentInput,
"code": "abc123",
"description": "abc123",
"name": "abc123",
"parentId": "xyz789",
"status": "abc123"
}
Response
{
"data": {
"productCategoriesAdd": {
"_id": "xyz789",
"attachment": Attachment,
"code": "abc123",
"description": "xyz789",
"isRoot": true,
"name": "abc123",
"order": "xyz789",
"parentId": "xyz789",
"productCount": 123,
"status": "xyz789"
}
}
}
productCategoriesEdit
Response
Returns a
ProductCategory
Example
Query
mutation ProductCategoriesEdit(
$_id: String!,
$attachment: AttachmentInput,
$code: String!,
$description: String,
$name: String!,
$parentId: String,
$status: String
) {
productCategoriesEdit(
_id: $_id,
attachment: $attachment,
code: $code,
description: $description,
name: $name,
parentId: $parentId,
status: $status
) {
_id
attachment {
duration
name
size
type
url
}
code
description
isRoot
name
order
parentId
productCount
status
}
}
Variables
{
"_id": "abc123",
"attachment": AttachmentInput,
"code": "abc123",
"description": "xyz789",
"name": "xyz789",
"parentId": "abc123",
"status": "abc123"
}
Response
{
"data": {
"productCategoriesEdit": {
"_id": "abc123",
"attachment": Attachment,
"code": "abc123",
"description": "xyz789",
"isRoot": false,
"name": "abc123",
"order": "abc123",
"parentId": "xyz789",
"productCount": 123,
"status": "xyz789"
}
}
}
productCategoriesRemove
productsAdd
Response
Returns a
Product
Arguments
| Name | Description |
|---|---|
attachment -
AttachmentInput
|
|
attachmentMore -
[AttachmentInput]
|
|
categoryId -
String
|
|
code -
String
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
minimiumCount -
Int
|
|
name -
String
|
|
productCount -
Int
|
|
sku -
String
|
|
supply -
String
|
|
type -
String
|
|
unitPrice -
Float
|
|
vendorId -
String
|
Example
Query
mutation ProductsAdd(
$attachment: AttachmentInput,
$attachmentMore: [AttachmentInput],
$categoryId: String,
$code: String,
$customFieldsData: JSON,
$description: String,
$minimiumCount: Int,
$name: String,
$productCount: Int,
$sku: String,
$supply: String,
$type: String,
$unitPrice: Float,
$vendorId: String
) {
productsAdd(
attachment: $attachment,
attachmentMore: $attachmentMore,
categoryId: $categoryId,
code: $code,
customFieldsData: $customFieldsData,
description: $description,
minimiumCount: $minimiumCount,
name: $name,
productCount: $productCount,
sku: $sku,
supply: $supply,
type: $type,
unitPrice: $unitPrice,
vendorId: $vendorId
) {
_id
attachment {
duration
name
size
type
url
}
attachmentMore {
duration
name
size
type
url
}
category {
_id
attachment {
...AttachmentFragment
}
code
description
isRoot
name
order
parentId
productCount
status
}
categoryId
code
createdAt
customFieldsData
description
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
vendorId
}
}
Variables
{
"attachment": AttachmentInput,
"attachmentMore": [AttachmentInput],
"categoryId": "abc123",
"code": "abc123",
"customFieldsData": {},
"description": "abc123",
"minimiumCount": 987,
"name": "abc123",
"productCount": 123,
"sku": "xyz789",
"supply": "xyz789",
"type": "xyz789",
"unitPrice": 987.65,
"vendorId": "xyz789"
}
Response
{
"data": {
"productsAdd": {
"_id": "xyz789",
"attachment": Attachment,
"attachmentMore": [Attachment],
"category": ProductCategory,
"categoryId": "abc123",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "abc123",
"getTags": [Tag],
"minimiumCount": 987,
"name": "abc123",
"productCount": 123,
"sku": "abc123",
"supply": "xyz789",
"tagIds": ["abc123"],
"type": "abc123",
"unitPrice": 123.45,
"vendor": Company,
"vendorId": "xyz789"
}
}
}
productsEdit
Response
Returns a
Product
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
attachment -
AttachmentInput
|
|
attachmentMore -
[AttachmentInput]
|
|
categoryId -
String
|
|
code -
String
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
minimiumCount -
Int
|
|
name -
String
|
|
productCount -
Int
|
|
sku -
String
|
|
supply -
String
|
|
type -
String
|
|
unitPrice -
Float
|
|
vendorId -
String
|
Example
Query
mutation ProductsEdit(
$_id: String!,
$attachment: AttachmentInput,
$attachmentMore: [AttachmentInput],
$categoryId: String,
$code: String,
$customFieldsData: JSON,
$description: String,
$minimiumCount: Int,
$name: String,
$productCount: Int,
$sku: String,
$supply: String,
$type: String,
$unitPrice: Float,
$vendorId: String
) {
productsEdit(
_id: $_id,
attachment: $attachment,
attachmentMore: $attachmentMore,
categoryId: $categoryId,
code: $code,
customFieldsData: $customFieldsData,
description: $description,
minimiumCount: $minimiumCount,
name: $name,
productCount: $productCount,
sku: $sku,
supply: $supply,
type: $type,
unitPrice: $unitPrice,
vendorId: $vendorId
) {
_id
attachment {
duration
name
size
type
url
}
attachmentMore {
duration
name
size
type
url
}
category {
_id
attachment {
...AttachmentFragment
}
code
description
isRoot
name
order
parentId
productCount
status
}
categoryId
code
createdAt
customFieldsData
description
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
vendorId
}
}
Variables
{
"_id": "abc123",
"attachment": AttachmentInput,
"attachmentMore": [AttachmentInput],
"categoryId": "abc123",
"code": "abc123",
"customFieldsData": {},
"description": "abc123",
"minimiumCount": 123,
"name": "xyz789",
"productCount": 987,
"sku": "abc123",
"supply": "xyz789",
"type": "abc123",
"unitPrice": 987.65,
"vendorId": "abc123"
}
Response
{
"data": {
"productsEdit": {
"_id": "abc123",
"attachment": Attachment,
"attachmentMore": [Attachment],
"category": ProductCategory,
"categoryId": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "abc123",
"getTags": [Tag],
"minimiumCount": 987,
"name": "abc123",
"productCount": 123,
"sku": "abc123",
"supply": "xyz789",
"tagIds": ["abc123"],
"type": "xyz789",
"unitPrice": 987.65,
"vendor": Company,
"vendorId": "xyz789"
}
}
}
productsMerge
Example
Query
mutation ProductsMerge(
$productFields: JSON,
$productIds: [String]
) {
productsMerge(
productFields: $productFields,
productIds: $productIds
) {
_id
attachment {
duration
name
size
type
url
}
attachmentMore {
duration
name
size
type
url
}
category {
_id
attachment {
...AttachmentFragment
}
code
description
isRoot
name
order
parentId
productCount
status
}
categoryId
code
createdAt
customFieldsData
description
getTags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
minimiumCount
name
productCount
sku
supply
tagIds
type
unitPrice
vendor {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
vendorId
}
}
Variables
{
"productFields": {},
"productIds": ["abc123"]
}
Response
{
"data": {
"productsMerge": {
"_id": "xyz789",
"attachment": Attachment,
"attachmentMore": [Attachment],
"category": ProductCategory,
"categoryId": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"getTags": [Tag],
"minimiumCount": 123,
"name": "abc123",
"productCount": 123,
"sku": "xyz789",
"supply": "abc123",
"tagIds": ["xyz789"],
"type": "xyz789",
"unitPrice": 123.45,
"vendor": Company,
"vendorId": "xyz789"
}
}
}
productsRemove
removeSkill
removeSkillType
renderDashboard
Response
Returns a
String
Example
Query
mutation RenderDashboard {
renderDashboard
}
Response
{"data": {"renderDashboard": "abc123"}}
resetPassword
Example
Query
mutation ResetPassword(
$newPassword: String!,
$token: String!
) {
resetPassword(
newPassword: $newPassword,
token: $token
)
}
Variables
{
"newPassword": "xyz789",
"token": "xyz789"
}
Response
{"data": {"resetPassword": {}}}
responseTemplatesAdd
Response
Returns a
ResponseTemplate
Example
Query
mutation ResponseTemplatesAdd(
$brandId: String!,
$content: String,
$files: JSON,
$name: String!
) {
responseTemplatesAdd(
brandId: $brandId,
content: $content,
files: $files,
name: $name
) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
content
files
name
}
}
Variables
{
"brandId": "abc123",
"content": "abc123",
"files": {},
"name": "xyz789"
}
Response
{
"data": {
"responseTemplatesAdd": {
"_id": "xyz789",
"brand": Brand,
"brandId": "xyz789",
"content": "xyz789",
"files": {},
"name": "abc123"
}
}
}
responseTemplatesEdit
Response
Returns a
ResponseTemplate
Example
Query
mutation ResponseTemplatesEdit(
$_id: String!,
$brandId: String!,
$content: String,
$files: JSON,
$name: String!
) {
responseTemplatesEdit(
_id: $_id,
brandId: $brandId,
content: $content,
files: $files,
name: $name
) {
_id
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
content
files
name
}
}
Variables
{
"_id": "xyz789",
"brandId": "abc123",
"content": "xyz789",
"files": {},
"name": "abc123"
}
Response
{
"data": {
"responseTemplatesEdit": {
"_id": "xyz789",
"brand": Brand,
"brandId": "xyz789",
"content": "abc123",
"files": {},
"name": "abc123"
}
}
}
responseTemplatesRemove
robotEntriesMarkAsNotified
Response
Returns
[RobotEntry]
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
mutation RobotEntriesMarkAsNotified($_id: String) {
robotEntriesMarkAsNotified(_id: $_id) {
_id
action
data
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"robotEntriesMarkAsNotified": [
{
"_id": "xyz789",
"action": "abc123",
"data": {}
}
]
}
}
scriptsAdd
Response
Returns a
Script
Example
Query
mutation ScriptsAdd(
$kbTopicId: String,
$leadIds: [String],
$messengerId: String,
$name: String!
) {
scriptsAdd(
kbTopicId: $kbTopicId,
leadIds: $leadIds,
messengerId: $messengerId,
name: $name
) {
_id
kbTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
kbTopicId
leadIds
leads {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
messenger {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
messengerId
name
}
}
Variables
{
"kbTopicId": "xyz789",
"leadIds": ["abc123"],
"messengerId": "xyz789",
"name": "xyz789"
}
Response
{
"data": {
"scriptsAdd": {
"_id": "xyz789",
"kbTopic": KnowledgeBaseTopic,
"kbTopicId": "xyz789",
"leadIds": ["abc123"],
"leads": [Integration],
"messenger": Integration,
"messengerId": "xyz789",
"name": "abc123"
}
}
}
scriptsEdit
Response
Returns a
Script
Example
Query
mutation ScriptsEdit(
$_id: String!,
$kbTopicId: String,
$leadIds: [String],
$messengerId: String,
$name: String!
) {
scriptsEdit(
_id: $_id,
kbTopicId: $kbTopicId,
leadIds: $leadIds,
messengerId: $messengerId,
name: $name
) {
_id
kbTopic {
_id
backgroundImage
brand {
...BrandFragment
}
categories {
...KnowledgeBaseCategoryFragment
}
color
createdBy
createdDate
description
languageCode
modifiedBy
modifiedDate
parentCategories {
...KnowledgeBaseParentCategoryFragment
}
title
}
kbTopicId
leadIds
leads {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
messenger {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
messengerId
name
}
}
Variables
{
"_id": "xyz789",
"kbTopicId": "xyz789",
"leadIds": ["xyz789"],
"messengerId": "xyz789",
"name": "abc123"
}
Response
{
"data": {
"scriptsEdit": {
"_id": "abc123",
"kbTopic": KnowledgeBaseTopic,
"kbTopicId": "abc123",
"leadIds": ["xyz789"],
"leads": [Integration],
"messenger": Integration,
"messengerId": "abc123",
"name": "xyz789"
}
}
}
scriptsRemove
segmentsAdd
Response
Returns a
Segment
Arguments
| Name | Description |
|---|---|
color -
String
|
|
conditionSegments -
[SubSegment]
|
|
conditions -
[SegmentCondition]
|
|
conditionsConjunction -
String
|
|
config -
JSON
|
|
contentType -
String!
|
|
description -
String
|
|
name -
String
|
|
shouldWriteActivityLog -
Boolean!
|
|
subOf -
String
|
Example
Query
mutation SegmentsAdd(
$color: String,
$conditionSegments: [SubSegment],
$conditions: [SegmentCondition],
$conditionsConjunction: String,
$config: JSON,
$contentType: String!,
$description: String,
$name: String,
$shouldWriteActivityLog: Boolean!,
$subOf: String
) {
segmentsAdd(
color: $color,
conditionSegments: $conditionSegments,
conditions: $conditions,
conditionsConjunction: $conditionsConjunction,
config: $config,
contentType: $contentType,
description: $description,
name: $name,
shouldWriteActivityLog: $shouldWriteActivityLog,
subOf: $subOf
) {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
}
}
Variables
{
"color": "abc123",
"conditionSegments": [SubSegment],
"conditions": [SegmentCondition],
"conditionsConjunction": "abc123",
"config": {},
"contentType": "xyz789",
"description": "xyz789",
"name": "abc123",
"shouldWriteActivityLog": true,
"subOf": "xyz789"
}
Response
{
"data": {
"segmentsAdd": {
"_id": "xyz789",
"color": "abc123",
"conditions": {},
"conditionsConjunction": "xyz789",
"config": {},
"contentType": "xyz789",
"count": 987,
"description": "abc123",
"getSubSegments": [Segment],
"name": "xyz789",
"shouldWriteActivityLog": false,
"subOf": "abc123",
"subSegmentConditions": [Segment]
}
}
}
segmentsEdit
Response
Returns a
Segment
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
color -
String
|
|
conditionSegments -
[SubSegment]
|
|
conditions -
[SegmentCondition]
|
|
conditionsConjunction -
String
|
|
config -
JSON
|
|
description -
String
|
|
name -
String
|
|
shouldWriteActivityLog -
Boolean!
|
|
subOf -
String
|
Example
Query
mutation SegmentsEdit(
$_id: String!,
$color: String,
$conditionSegments: [SubSegment],
$conditions: [SegmentCondition],
$conditionsConjunction: String,
$config: JSON,
$description: String,
$name: String,
$shouldWriteActivityLog: Boolean!,
$subOf: String
) {
segmentsEdit(
_id: $_id,
color: $color,
conditionSegments: $conditionSegments,
conditions: $conditions,
conditionsConjunction: $conditionsConjunction,
config: $config,
description: $description,
name: $name,
shouldWriteActivityLog: $shouldWriteActivityLog,
subOf: $subOf
) {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
_id
color
conditions
conditionsConjunction
config
contentType
count
description
getSubSegments {
...SegmentFragment
}
name
shouldWriteActivityLog
subOf
subSegmentConditions {
...SegmentFragment
}
}
}
}
Variables
{
"_id": "abc123",
"color": "xyz789",
"conditionSegments": [SubSegment],
"conditions": [SegmentCondition],
"conditionsConjunction": "abc123",
"config": {},
"description": "abc123",
"name": "xyz789",
"shouldWriteActivityLog": true,
"subOf": "xyz789"
}
Response
{
"data": {
"segmentsEdit": {
"_id": "xyz789",
"color": "abc123",
"conditions": {},
"conditionsConjunction": "abc123",
"config": {},
"contentType": "xyz789",
"count": 987,
"description": "xyz789",
"getSubSegments": [Segment],
"name": "abc123",
"shouldWriteActivityLog": true,
"subOf": "xyz789",
"subSegmentConditions": [Segment]
}
}
}
segmentsRemove
spinCampaignsAdd
Response
Returns a
SpinCampaign
Example
Query
mutation SpinCampaignsAdd(
$attachment: AttachmentInput,
$awards: JSON,
$buyScore: Float,
$description: String,
$endDate: Date,
$finishDateOfUse: Date,
$startDate: Date,
$status: String,
$title: String
) {
spinCampaignsAdd(
attachment: $attachment,
awards: $awards,
buyScore: $buyScore,
description: $description,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
startDate: $startDate,
status: $status,
title: $title
) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
modifiedAt
modifiedBy
spinsCount
startDate
status
title
}
}
Variables
{
"attachment": AttachmentInput,
"awards": {},
"buyScore": 123.45,
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
Response
{
"data": {
"spinCampaignsAdd": {
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"spinsCount": 123,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
}
}
spinCampaignsEdit
Response
Returns a
SpinCampaign
Example
Query
mutation SpinCampaignsEdit(
$_id: String!,
$attachment: AttachmentInput,
$awards: JSON,
$buyScore: Float,
$description: String,
$endDate: Date,
$finishDateOfUse: Date,
$startDate: Date,
$status: String,
$title: String
) {
spinCampaignsEdit(
_id: $_id,
attachment: $attachment,
awards: $awards,
buyScore: $buyScore,
description: $description,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
startDate: $startDate,
status: $status,
title: $title
) {
_id
attachment {
duration
name
size
type
url
}
awards
buyScore
createdAt
createdBy
description
endDate
finishDateOfUse
modifiedAt
modifiedBy
spinsCount
startDate
status
title
}
}
Variables
{
"_id": "abc123",
"attachment": AttachmentInput,
"awards": {},
"buyScore": 987.65,
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
Response
{
"data": {
"spinCampaignsEdit": {
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 987.65,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"spinsCount": 123,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123"
}
}
}
spinCampaignsRemove
spinsAdd
Response
Returns a
Spin
Example
Query
mutation SpinsAdd(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$status: String,
$usedAt: Date
) {
spinsAdd(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
status: $status,
usedAt: $usedAt
) {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"campaignId": "abc123",
"ownerId": "abc123",
"ownerType": "xyz789",
"status": "abc123",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"spinsAdd": {
"_id": "abc123",
"awardId": "xyz789",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
}
}
spinsEdit
Response
Returns a
Spin
Example
Query
mutation SpinsEdit(
$_id: String!,
$campaignId: String,
$ownerId: String,
$ownerType: String,
$status: String,
$usedAt: Date
) {
spinsEdit(
_id: $_id,
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
status: $status,
usedAt: $usedAt
) {
_id
awardId
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
voucherId
}
}
Variables
{
"_id": "abc123",
"campaignId": "abc123",
"ownerId": "xyz789",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"spinsEdit": {
"_id": "abc123",
"awardId": "xyz789",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
}
}
spinsRemove
stagesEdit
Response
Returns a
Stage
Example
Query
mutation StagesEdit(
$_id: String!,
$name: String,
$status: String,
$type: String
) {
stagesEdit(
_id: $_id,
name: $name,
status: $status,
type: $type
) {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
}
Variables
{
"_id": "abc123",
"name": "xyz789",
"status": "xyz789",
"type": "xyz789"
}
Response
{
"data": {
"stagesEdit": {
"_id": "xyz789",
"age": 987,
"amount": {},
"code": "xyz789",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["xyz789"],
"formId": "xyz789",
"inProcessDealsTotalCount": 987,
"initialDealsTotalCount": 123,
"itemsTotalCount": 987,
"memberIds": ["xyz789"],
"members": [User],
"name": "xyz789",
"order": 987,
"pipelineId": "abc123",
"probability": "xyz789",
"status": "xyz789",
"stayedDealsTotalCount": 987,
"type": "abc123",
"visibility": "xyz789"
}
}
}
stagesRemove
stagesSortItems
Response
Returns a
String
Example
Query
mutation StagesSortItems(
$proccessId: String,
$sortType: String,
$stageId: String!,
$type: String
) {
stagesSortItems(
proccessId: $proccessId,
sortType: $sortType,
stageId: $stageId,
type: $type
)
}
Variables
{
"proccessId": "abc123",
"sortType": "abc123",
"stageId": "abc123",
"type": "xyz789"
}
Response
{"data": {"stagesSortItems": "xyz789"}}
stagesUpdateOrder
Response
Returns
[Stage]
Arguments
| Name | Description |
|---|---|
orders -
[OrderItem]
|
Example
Query
mutation StagesUpdateOrder($orders: [OrderItem]) {
stagesUpdateOrder(orders: $orders) {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
}
Variables
{"orders": [OrderItem]}
Response
{
"data": {
"stagesUpdateOrder": [
{
"_id": "xyz789",
"age": 123,
"amount": {},
"code": "abc123",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["xyz789"],
"formId": "abc123",
"inProcessDealsTotalCount": 123,
"initialDealsTotalCount": 123,
"itemsTotalCount": 987,
"memberIds": ["xyz789"],
"members": [User],
"name": "abc123",
"order": 987,
"pipelineId": "abc123",
"probability": "xyz789",
"status": "xyz789",
"stayedDealsTotalCount": 123,
"type": "xyz789",
"visibility": "abc123"
}
]
}
}
structuresAdd
Response
Returns a
Structure
Arguments
| Name | Description |
|---|---|
code -
String
|
|
coordinate -
CoordinateInput
|
|
description -
String
|
|
email -
String
|
|
image -
AttachmentInput
|
|
links -
JSON
|
|
phoneNumber -
String
|
|
supervisorId -
String
|
|
title -
String!
|
|
website -
String
|
Example
Query
mutation StructuresAdd(
$code: String,
$coordinate: CoordinateInput,
$description: String,
$email: String,
$image: AttachmentInput,
$links: JSON,
$phoneNumber: String,
$supervisorId: String,
$title: String!,
$website: String
) {
structuresAdd(
code: $code,
coordinate: $coordinate,
description: $description,
email: $email,
image: $image,
links: $links,
phoneNumber: $phoneNumber,
supervisorId: $supervisorId,
title: $title,
website: $website
) {
_id
code
coordinate {
latitude
longitude
}
description
email
image {
duration
name
size
type
url
}
links
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
}
}
Variables
{
"code": "abc123",
"coordinate": CoordinateInput,
"description": "abc123",
"email": "abc123",
"image": AttachmentInput,
"links": {},
"phoneNumber": "xyz789",
"supervisorId": "abc123",
"title": "abc123",
"website": "xyz789"
}
Response
{
"data": {
"structuresAdd": {
"_id": "xyz789",
"code": "abc123",
"coordinate": Coordinate,
"description": "abc123",
"email": "xyz789",
"image": Attachment,
"links": {},
"phoneNumber": "abc123",
"supervisor": User,
"supervisorId": "abc123",
"title": "abc123"
}
}
}
structuresEdit
Response
Returns a
Structure
Example
Query
mutation StructuresEdit(
$_id: String!,
$code: String,
$coordinate: CoordinateInput,
$description: String,
$email: String,
$image: AttachmentInput,
$links: JSON,
$phoneNumber: String,
$supervisorId: String,
$title: String!,
$website: String
) {
structuresEdit(
_id: $_id,
code: $code,
coordinate: $coordinate,
description: $description,
email: $email,
image: $image,
links: $links,
phoneNumber: $phoneNumber,
supervisorId: $supervisorId,
title: $title,
website: $website
) {
_id
code
coordinate {
latitude
longitude
}
description
email
image {
duration
name
size
type
url
}
links
phoneNumber
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
}
}
Variables
{
"_id": "abc123",
"code": "abc123",
"coordinate": CoordinateInput,
"description": "abc123",
"email": "xyz789",
"image": AttachmentInput,
"links": {},
"phoneNumber": "abc123",
"supervisorId": "abc123",
"title": "abc123",
"website": "xyz789"
}
Response
{
"data": {
"structuresEdit": {
"_id": "xyz789",
"code": "abc123",
"coordinate": Coordinate,
"description": "xyz789",
"email": "abc123",
"image": Attachment,
"links": {},
"phoneNumber": "abc123",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789"
}
}
}
structuresRemove
tasksAdd
Response
Returns a
Task
Arguments
| Name | Description |
|---|---|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
companyIds -
[String]
|
|
customFieldsData -
JSON
|
|
customerIds -
[String]
|
|
description -
String
|
|
isComplete -
Boolean
|
|
labelIds -
[String]
|
|
name -
String!
|
|
order -
Int
|
|
priority -
String
|
|
proccessId -
String
|
|
reminderMinute -
Int
|
|
sourceConversationIds -
[String]
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
Example
Query
mutation TasksAdd(
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$companyIds: [String],
$customFieldsData: JSON,
$customerIds: [String],
$description: String,
$isComplete: Boolean,
$labelIds: [String],
$name: String!,
$order: Int,
$priority: String,
$proccessId: String,
$reminderMinute: Int,
$sourceConversationIds: [String],
$stageId: String,
$startDate: Date,
$status: String
) {
tasksAdd(
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
companyIds: $companyIds,
customFieldsData: $customFieldsData,
customerIds: $customerIds,
description: $description,
isComplete: $isComplete,
labelIds: $labelIds,
name: $name,
order: $order,
priority: $priority,
proccessId: $proccessId,
reminderMinute: $reminderMinute,
sourceConversationIds: $sourceConversationIds,
stageId: $stageId,
startDate: $startDate,
status: $status
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"aboveItemId": "xyz789",
"assignedUserIds": ["xyz789"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"companyIds": ["xyz789"],
"customFieldsData": {},
"customerIds": ["xyz789"],
"description": "xyz789",
"isComplete": false,
"labelIds": ["abc123"],
"name": "xyz789",
"order": 123,
"priority": "xyz789",
"proccessId": "abc123",
"reminderMinute": 123,
"sourceConversationIds": ["abc123"],
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789"
}
Response
{
"data": {
"tasksAdd": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "xyz789",
"order": 123.45,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 123,
"score": 987.65,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
tasksArchive
Example
Query
mutation TasksArchive(
$proccessId: String,
$stageId: String!
) {
tasksArchive(
proccessId: $proccessId,
stageId: $stageId
)
}
Variables
{
"proccessId": "xyz789",
"stageId": "xyz789"
}
Response
{"data": {"tasksArchive": "xyz789"}}
tasksChange
Response
Returns a
Task
Example
Query
mutation TasksChange(
$aboveItemId: String,
$destinationStageId: String!,
$itemId: String!,
$proccessId: String,
$sourceStageId: String
) {
tasksChange(
aboveItemId: $aboveItemId,
destinationStageId: $destinationStageId,
itemId: $itemId,
proccessId: $proccessId,
sourceStageId: $sourceStageId
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"aboveItemId": "xyz789",
"destinationStageId": "xyz789",
"itemId": "xyz789",
"proccessId": "xyz789",
"sourceStageId": "xyz789"
}
Response
{
"data": {
"tasksChange": {
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 123,
"score": 123.45,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
tasksCopy
Example
Query
mutation TasksCopy(
$_id: String!,
$proccessId: String
) {
tasksCopy(
_id: $_id,
proccessId: $proccessId
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"_id": "xyz789",
"proccessId": "xyz789"
}
Response
{
"data": {
"tasksCopy": {
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 987.65,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
tasksEdit
Response
Returns a
Task
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
isComplete -
Boolean
|
|
name -
String
|
|
order -
Int
|
|
priority -
String
|
|
proccessId -
String
|
|
reminderMinute -
Int
|
|
sourceConversationIds -
[String]
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
Example
Query
mutation TasksEdit(
$_id: String!,
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$customFieldsData: JSON,
$description: String,
$isComplete: Boolean,
$name: String,
$order: Int,
$priority: String,
$proccessId: String,
$reminderMinute: Int,
$sourceConversationIds: [String],
$stageId: String,
$startDate: Date,
$status: String
) {
tasksEdit(
_id: $_id,
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
customFieldsData: $customFieldsData,
description: $description,
isComplete: $isComplete,
name: $name,
order: $order,
priority: $priority,
proccessId: $proccessId,
reminderMinute: $reminderMinute,
sourceConversationIds: $sourceConversationIds,
stageId: $stageId,
startDate: $startDate,
status: $status
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"_id": "abc123",
"aboveItemId": "xyz789",
"assignedUserIds": ["xyz789"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"isComplete": false,
"name": "xyz789",
"order": 987,
"priority": "xyz789",
"proccessId": "abc123",
"reminderMinute": 987,
"sourceConversationIds": ["abc123"],
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123"
}
Response
{
"data": {
"tasksEdit": {
"_id": "xyz789",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
tasksRemove
Example
Query
mutation TasksRemove($_id: String!) {
tasksRemove(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"tasksRemove": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 987,
"score": 123.45,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
tasksWatch
Example
Query
mutation TasksWatch(
$_id: String,
$isAdd: Boolean
) {
tasksWatch(
_id: $_id,
isAdd: $isAdd
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "xyz789", "isAdd": true}
Response
{
"data": {
"tasksWatch": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 123.45,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 987,
"score": 123.45,
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
ticketsAdd
Response
Returns a
Ticket
Arguments
| Name | Description |
|---|---|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
companyIds -
[String]
|
|
customFieldsData -
JSON
|
|
customerIds -
[String]
|
|
description -
String
|
|
isComplete -
Boolean
|
|
labelIds -
[String]
|
|
name -
String!
|
|
order -
Int
|
|
priority -
String
|
|
proccessId -
String
|
|
reminderMinute -
Int
|
|
source -
String
|
|
sourceConversationIds -
[String]
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
Example
Query
mutation TicketsAdd(
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$companyIds: [String],
$customFieldsData: JSON,
$customerIds: [String],
$description: String,
$isComplete: Boolean,
$labelIds: [String],
$name: String!,
$order: Int,
$priority: String,
$proccessId: String,
$reminderMinute: Int,
$source: String,
$sourceConversationIds: [String],
$stageId: String,
$startDate: Date,
$status: String
) {
ticketsAdd(
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
companyIds: $companyIds,
customFieldsData: $customFieldsData,
customerIds: $customerIds,
description: $description,
isComplete: $isComplete,
labelIds: $labelIds,
name: $name,
order: $order,
priority: $priority,
proccessId: $proccessId,
reminderMinute: $reminderMinute,
source: $source,
sourceConversationIds: $sourceConversationIds,
stageId: $stageId,
startDate: $startDate,
status: $status
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"aboveItemId": "abc123",
"assignedUserIds": ["xyz789"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"companyIds": ["xyz789"],
"customFieldsData": {},
"customerIds": ["abc123"],
"description": "xyz789",
"isComplete": false,
"labelIds": ["xyz789"],
"name": "xyz789",
"order": 123,
"priority": "abc123",
"proccessId": "abc123",
"reminderMinute": 987,
"source": "abc123",
"sourceConversationIds": ["xyz789"],
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123"
}
Response
{
"data": {
"ticketsAdd": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 123,
"score": 123.45,
"source": "abc123",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
ticketsArchive
Example
Query
mutation TicketsArchive(
$proccessId: String,
$stageId: String!
) {
ticketsArchive(
proccessId: $proccessId,
stageId: $stageId
)
}
Variables
{
"proccessId": "abc123",
"stageId": "abc123"
}
Response
{"data": {"ticketsArchive": "abc123"}}
ticketsChange
Response
Returns a
Ticket
Example
Query
mutation TicketsChange(
$aboveItemId: String,
$destinationStageId: String!,
$itemId: String!,
$proccessId: String,
$sourceStageId: String
) {
ticketsChange(
aboveItemId: $aboveItemId,
destinationStageId: $destinationStageId,
itemId: $itemId,
proccessId: $proccessId,
sourceStageId: $sourceStageId
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"aboveItemId": "xyz789",
"destinationStageId": "xyz789",
"itemId": "abc123",
"proccessId": "abc123",
"sourceStageId": "abc123"
}
Response
{
"data": {
"ticketsChange": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 123.45,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 123,
"score": 987.65,
"source": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
ticketsCopy
Example
Query
mutation TicketsCopy(
$_id: String!,
$proccessId: String
) {
ticketsCopy(
_id: $_id,
proccessId: $proccessId
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"_id": "abc123",
"proccessId": "abc123"
}
Response
{
"data": {
"ticketsCopy": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": false,
"isComplete": true,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "abc123",
"order": 123.45,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 123,
"score": 987.65,
"source": "xyz789",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
ticketsEdit
Response
Returns a
Ticket
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
aboveItemId -
String
|
|
assignedUserIds -
[String]
|
|
attachments -
[AttachmentInput]
|
|
closeDate -
Date
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
isComplete -
Boolean
|
|
name -
String
|
|
order -
Int
|
|
priority -
String
|
|
proccessId -
String
|
|
reminderMinute -
Int
|
|
source -
String
|
|
sourceConversationIds -
[String]
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
Example
Query
mutation TicketsEdit(
$_id: String!,
$aboveItemId: String,
$assignedUserIds: [String],
$attachments: [AttachmentInput],
$closeDate: Date,
$customFieldsData: JSON,
$description: String,
$isComplete: Boolean,
$name: String,
$order: Int,
$priority: String,
$proccessId: String,
$reminderMinute: Int,
$source: String,
$sourceConversationIds: [String],
$stageId: String,
$startDate: Date,
$status: String
) {
ticketsEdit(
_id: $_id,
aboveItemId: $aboveItemId,
assignedUserIds: $assignedUserIds,
attachments: $attachments,
closeDate: $closeDate,
customFieldsData: $customFieldsData,
description: $description,
isComplete: $isComplete,
name: $name,
order: $order,
priority: $priority,
proccessId: $proccessId,
reminderMinute: $reminderMinute,
source: $source,
sourceConversationIds: $sourceConversationIds,
stageId: $stageId,
startDate: $startDate,
status: $status
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{
"_id": "xyz789",
"aboveItemId": "xyz789",
"assignedUserIds": ["xyz789"],
"attachments": [AttachmentInput],
"closeDate": "2007-12-03",
"customFieldsData": {},
"description": "xyz789",
"isComplete": false,
"name": "abc123",
"order": 123,
"priority": "xyz789",
"proccessId": "xyz789",
"reminderMinute": 987,
"source": "xyz789",
"sourceConversationIds": ["abc123"],
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123"
}
Response
{
"data": {
"ticketsEdit": {
"_id": "xyz789",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": false,
"isComplete": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 123.45,
"source": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
ticketsRemove
Example
Query
mutation TicketsRemove($_id: String!) {
ticketsRemove(_id: $_id) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"ticketsRemove": {
"_id": "abc123",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 987.65,
"source": "abc123",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
}
}
ticketsWatch
Example
Query
mutation TicketsWatch(
$_id: String,
$isAdd: Boolean
) {
ticketsWatch(
_id: $_id,
isAdd: $isAdd
) {
_id
assignedUserIds
assignedUsers {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
attachments {
duration
name
size
type
url
}
boardId
closeDate
companies {
_id
avatar
businessType
code
createdAt
customFieldsData
customers {
...CustomerFragment
}
description
emails
getTags {
...TagFragment
}
industry
isSubscribed
links
location
mergedIds
modifiedAt
names
owner {
...UserFragment
}
ownerId
parentCompany {
...CompanyFragment
}
parentCompanyId
phones
plan
primaryEmail
primaryName
primaryPhone
score
size
tagIds
trackedData
website
}
createdAt
createdUser {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
customFieldsData
customers {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
description
hasNotified
isComplete
isWatched
labelIds
labels {
_id
colorCode
createdAt
createdBy
name
pipelineId
}
modifiedAt
modifiedBy
name
number
order
pipeline {
_id
bgColor
boardId
createdAt
createdUser {
...UserFragment
}
departmentIds
endDate
excludeCheckUserIds
hackScoringType
isCheckDepartment
isCheckUser
isWatched
itemsTotalCount
memberIds
members {
...UserFragment
}
metric
name
numberConfig
numberSize
order
startDate
state
status
templateId
type
userId
visibility
}
priority
reminderMinute
score
source
stage {
_id
age
amount
code
compareNextStage
createdAt
departmentIds
formId
inProcessDealsTotalCount
initialDealsTotalCount
itemsTotalCount
memberIds
members {
...UserFragment
}
name
order
pipelineId
probability
status
stayedDealsTotalCount
type
visibility
}
stageId
startDate
status
timeTrack {
startDate
status
timeSpent
}
userId
}
}
Variables
{"_id": "abc123", "isAdd": false}
Response
{
"data": {
"ticketsWatch": {
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": true,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "abc123",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reminderMinute": 987,
"score": 123.45,
"source": "xyz789",
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
}
}
unitsAdd
Response
Returns a
Unit
Example
Query
mutation UnitsAdd(
$code: String,
$departmentId: String,
$description: String,
$supervisorId: String,
$title: String,
$userIds: [String]
) {
unitsAdd(
code: $code,
departmentId: $departmentId,
description: $description,
supervisorId: $supervisorId,
title: $title,
userIds: $userIds
) {
_id
code
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
departmentId
description
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"code": "abc123",
"departmentId": "abc123",
"description": "xyz789",
"supervisorId": "xyz789",
"title": "abc123",
"userIds": ["xyz789"]
}
Response
{
"data": {
"unitsAdd": {
"_id": "abc123",
"code": "xyz789",
"department": Department,
"departmentId": "xyz789",
"description": "xyz789",
"supervisor": User,
"supervisorId": "xyz789",
"title": "abc123",
"userIds": ["xyz789"],
"users": [User]
}
}
}
unitsEdit
Response
Returns a
Unit
Example
Query
mutation UnitsEdit(
$_id: String!,
$code: String,
$departmentId: String,
$description: String,
$supervisorId: String,
$title: String,
$userIds: [String]
) {
unitsEdit(
_id: $_id,
code: $code,
departmentId: $departmentId,
description: $description,
supervisorId: $supervisorId,
title: $title,
userIds: $userIds
) {
_id
code
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
departmentId
description
supervisor {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
supervisorId
title
userIds
users {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
}
}
Variables
{
"_id": "abc123",
"code": "xyz789",
"departmentId": "abc123",
"description": "abc123",
"supervisorId": "abc123",
"title": "xyz789",
"userIds": ["xyz789"]
}
Response
{
"data": {
"unitsEdit": {
"_id": "abc123",
"code": "xyz789",
"department": Department,
"departmentId": "abc123",
"description": "abc123",
"supervisor": User,
"supervisorId": "abc123",
"title": "xyz789",
"userIds": ["abc123"],
"users": [User]
}
}
}
unitsRemove
updateSkill
Response
Returns a
JSON
Example
Query
mutation UpdateSkill(
$_id: String!,
$exclude: Boolean,
$memberIds: [String],
$name: String,
$typeId: String
) {
updateSkill(
_id: $_id,
exclude: $exclude,
memberIds: $memberIds,
name: $name,
typeId: $typeId
)
}
Variables
{
"_id": "xyz789",
"exclude": true,
"memberIds": ["xyz789"],
"name": "abc123",
"typeId": "abc123"
}
Response
{"data": {"updateSkill": {}}}
updateSkillType
userRegistrationCreate
Example
Query
mutation UserRegistrationCreate(
$email: String,
$password: String
) {
userRegistrationCreate(
email: $email,
password: $password
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"email": "abc123",
"password": "xyz789"
}
Response
{
"data": {
"userRegistrationCreate": {
"_id": "xyz789",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": false,
"isSubscribed": "xyz789",
"leaderBoardPosition": 987,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "abc123",
"username": "abc123"
}
}
}
usersChangePassword
Example
Query
mutation UsersChangePassword(
$currentPassword: String!,
$newPassword: String!
) {
usersChangePassword(
currentPassword: $currentPassword,
newPassword: $newPassword
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"currentPassword": "abc123",
"newPassword": "xyz789"
}
Response
{
"data": {
"usersChangePassword": {
"_id": "xyz789",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": false,
"isSubscribed": "abc123",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "xyz789",
"username": "xyz789"
}
}
}
usersConfigEmailSignatures
Response
Returns a
User
Arguments
| Name | Description |
|---|---|
signatures -
[EmailSignature]
|
Example
Query
mutation UsersConfigEmailSignatures($signatures: [EmailSignature]) {
usersConfigEmailSignatures(signatures: $signatures) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"signatures": [EmailSignature]}
Response
{
"data": {
"usersConfigEmailSignatures": {
"_id": "abc123",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["xyz789"],
"isActive": true,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "xyz789",
"username": "xyz789"
}
}
}
usersConfigGetNotificationByEmail
Example
Query
mutation UsersConfigGetNotificationByEmail($isAllowed: Boolean) {
usersConfigGetNotificationByEmail(isAllowed: $isAllowed) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"isAllowed": true}
Response
{
"data": {
"usersConfigGetNotificationByEmail": {
"_id": "abc123",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["xyz789"],
"isActive": false,
"isOwner": true,
"isShowNotification": false,
"isSubscribed": "abc123",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "xyz789",
"username": "xyz789"
}
}
}
usersConfirmInvitation
Response
Returns a
User
Example
Query
mutation UsersConfirmInvitation(
$fullName: String,
$password: String,
$passwordConfirmation: String,
$token: String,
$username: String
) {
usersConfirmInvitation(
fullName: $fullName,
password: $password,
passwordConfirmation: $passwordConfirmation,
token: $token,
username: $username
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"fullName": "xyz789",
"password": "abc123",
"passwordConfirmation": "abc123",
"token": "abc123",
"username": "abc123"
}
Response
{
"data": {
"usersConfirmInvitation": {
"_id": "xyz789",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "xyz789",
"username": "abc123"
}
}
}
usersCreateOwner
Response
Returns a
String
Example
Query
mutation UsersCreateOwner(
$email: String!,
$firstName: String!,
$lastName: String,
$password: String!,
$purpose: String,
$subscribeEmail: Boolean
) {
usersCreateOwner(
email: $email,
firstName: $firstName,
lastName: $lastName,
password: $password,
purpose: $purpose,
subscribeEmail: $subscribeEmail
)
}
Variables
{
"email": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"password": "abc123",
"purpose": "xyz789",
"subscribeEmail": false
}
Response
{"data": {"usersCreateOwner": "abc123"}}
usersEdit
Response
Returns a
User
Example
Query
mutation UsersEdit(
$_id: String!,
$brandIds: [String],
$channelIds: [String],
$customFieldsData: JSON,
$details: UserDetails,
$email: String,
$groupIds: [String],
$links: JSON,
$username: String
) {
usersEdit(
_id: $_id,
brandIds: $brandIds,
channelIds: $channelIds,
customFieldsData: $customFieldsData,
details: $details,
email: $email,
groupIds: $groupIds,
links: $links,
username: $username
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"_id": "xyz789",
"brandIds": ["xyz789"],
"channelIds": ["xyz789"],
"customFieldsData": {},
"details": UserDetails,
"email": "abc123",
"groupIds": ["xyz789"],
"links": {},
"username": "abc123"
}
Response
{
"data": {
"usersEdit": {
"_id": "xyz789",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": false,
"isSubscribed": "abc123",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "xyz789",
"username": "xyz789"
}
}
}
usersEditProfile
Response
Returns a
User
Arguments
| Name | Description |
|---|---|
details -
UserDetails
|
|
email -
String!
|
|
links -
JSON
|
|
password -
String!
|
|
username -
String!
|
Example
Query
mutation UsersEditProfile(
$details: UserDetails,
$email: String!,
$links: JSON,
$password: String!,
$username: String!
) {
usersEditProfile(
details: $details,
email: $email,
links: $links,
password: $password,
username: $username
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"details": UserDetails,
"email": "abc123",
"links": {},
"password": "abc123",
"username": "abc123"
}
Response
{
"data": {
"usersEditProfile": {
"_id": "xyz789",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["xyz789"],
"isActive": true,
"isOwner": false,
"isShowNotification": false,
"isSubscribed": "abc123",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "xyz789",
"username": "abc123"
}
}
}
usersGroupsAdd
Response
Returns a
UsersGroup
Example
Query
mutation UsersGroupsAdd(
$description: String,
$memberIds: [String],
$name: String!
) {
usersGroupsAdd(
description: $description,
memberIds: $memberIds,
name: $name
) {
_id
description
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
}
}
Variables
{
"description": "xyz789",
"memberIds": ["xyz789"],
"name": "abc123"
}
Response
{
"data": {
"usersGroupsAdd": {
"_id": "abc123",
"description": "abc123",
"memberIds": ["xyz789"],
"members": [User],
"name": "xyz789"
}
}
}
usersGroupsCopy
Response
Returns a
UsersGroup
Example
Query
mutation UsersGroupsCopy(
$_id: String!,
$memberIds: [String]
) {
usersGroupsCopy(
_id: $_id,
memberIds: $memberIds
) {
_id
description
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
}
}
Variables
{
"_id": "xyz789",
"memberIds": ["abc123"]
}
Response
{
"data": {
"usersGroupsCopy": {
"_id": "xyz789",
"description": "abc123",
"memberIds": ["abc123"],
"members": [User],
"name": "xyz789"
}
}
}
usersGroupsEdit
Response
Returns a
UsersGroup
Example
Query
mutation UsersGroupsEdit(
$_id: String!,
$description: String,
$memberIds: [String],
$name: String!
) {
usersGroupsEdit(
_id: $_id,
description: $description,
memberIds: $memberIds,
name: $name
) {
_id
description
memberIds
members {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
name
}
}
Variables
{
"_id": "abc123",
"description": "xyz789",
"memberIds": ["abc123"],
"name": "xyz789"
}
Response
{
"data": {
"usersGroupsEdit": {
"_id": "abc123",
"description": "abc123",
"memberIds": ["xyz789"],
"members": [User],
"name": "abc123"
}
}
}
usersGroupsRemove
usersInvite
Response
Returns a
Boolean
Arguments
| Name | Description |
|---|---|
entries -
[InvitationEntry]
|
Example
Query
mutation UsersInvite($entries: [InvitationEntry]) {
usersInvite(entries: $entries)
}
Variables
{"entries": [InvitationEntry]}
Response
{"data": {"usersInvite": false}}
usersResendInvitation
usersResetMemberPassword
Example
Query
mutation UsersResetMemberPassword(
$_id: String!,
$newPassword: String!
) {
usersResetMemberPassword(
_id: $_id,
newPassword: $newPassword
) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{
"_id": "abc123",
"newPassword": "xyz789"
}
Response
{
"data": {
"usersResetMemberPassword": {
"_id": "abc123",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": false,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 123.45,
"status": "xyz789",
"username": "abc123"
}
}
}
usersSeenOnBoard
Response
Returns a
User
Example
Query
mutation UsersSeenOnBoard {
usersSeenOnBoard {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Response
{
"data": {
"usersSeenOnBoard": {
"_id": "xyz789",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["abc123"],
"isActive": false,
"isOwner": true,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 987,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "xyz789",
"username": "abc123"
}
}
}
usersSetActiveStatus
Example
Query
mutation UsersSetActiveStatus($_id: String!) {
usersSetActiveStatus(_id: $_id) {
_id
brandIds
brands {
_id
code
createdAt
description
emailConfig
name
userId
}
configs
configsConstants
createdAt
customFieldsData
department {
_id
childCount
children {
...DepartmentFragment
}
code
description
parent {
...DepartmentFragment
}
parentId
supervisor {
...UserFragment
}
supervisorId
title
userCount
userIds
users {
...UserFragment
}
}
details {
avatar
birthDate
description
fullName
location
operatorPhone
position
shortName
workStartedDate
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
_id
completedSteps
isCompleted
userId
}
permissionActions
score
status
username
}
}
Variables
{"_id": "xyz789"}
Response
{
"data": {
"usersSetActiveStatus": {
"_id": "abc123",
"brandIds": ["xyz789"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "abc123",
"emailSignatures": {},
"getNotificationByEmail": true,
"groupIds": ["xyz789"],
"isActive": true,
"isOwner": false,
"isShowNotification": false,
"isSubscribed": "xyz789",
"leaderBoardPosition": 987,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "abc123",
"username": "abc123"
}
}
}
voucherCampaignsAdd
Response
Returns a
VoucherCampaign
Arguments
| Name | Description |
|---|---|
attachment -
AttachmentInput
|
|
bonusCount -
Float
|
|
bonusProductId -
String
|
|
buyScore -
Float
|
|
coupon -
String
|
|
description -
String
|
|
discountPercent -
Float
|
|
endDate -
Date
|
|
finishDateOfUse -
Date
|
|
lotteryCampaignId -
String
|
|
lotteryCount -
Float
|
|
productCategoryIds -
[String]
|
|
productIds -
[String]
|
|
score -
Float
|
|
scoreAction -
String
|
|
spinCampaignId -
String
|
|
spinCount -
Float
|
|
startDate -
Date
|
|
status -
String
|
|
title -
String
|
|
voucherType -
String
|
Example
Query
mutation VoucherCampaignsAdd(
$attachment: AttachmentInput,
$bonusCount: Float,
$bonusProductId: String,
$buyScore: Float,
$coupon: String,
$description: String,
$discountPercent: Float,
$endDate: Date,
$finishDateOfUse: Date,
$lotteryCampaignId: String,
$lotteryCount: Float,
$productCategoryIds: [String],
$productIds: [String],
$score: Float,
$scoreAction: String,
$spinCampaignId: String,
$spinCount: Float,
$startDate: Date,
$status: String,
$title: String,
$voucherType: String
) {
voucherCampaignsAdd(
attachment: $attachment,
bonusCount: $bonusCount,
bonusProductId: $bonusProductId,
buyScore: $buyScore,
coupon: $coupon,
description: $description,
discountPercent: $discountPercent,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
lotteryCampaignId: $lotteryCampaignId,
lotteryCount: $lotteryCount,
productCategoryIds: $productCategoryIds,
productIds: $productIds,
score: $score,
scoreAction: $scoreAction,
spinCampaignId: $spinCampaignId,
spinCount: $spinCount,
startDate: $startDate,
status: $status,
title: $title,
voucherType: $voucherType
) {
_id
attachment {
duration
name
size
type
url
}
bonusCount
bonusProductId
buyScore
coupon
createdAt
createdBy
description
discountPercent
endDate
finishDateOfUse
lotteryCampaignId
lotteryCount
modifiedAt
modifiedBy
productCategoryIds
productIds
score
scoreAction
spinCampaignId
spinCount
startDate
status
title
voucherType
vouchersCount
}
}
Variables
{
"attachment": AttachmentInput,
"bonusCount": 987.65,
"bonusProductId": "abc123",
"buyScore": 987.65,
"coupon": "xyz789",
"description": "xyz789",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "xyz789",
"lotteryCount": 123.45,
"productCategoryIds": ["abc123"],
"productIds": ["xyz789"],
"score": 123.45,
"scoreAction": "xyz789",
"spinCampaignId": "xyz789",
"spinCount": 987.65,
"startDate": "2007-12-03",
"status": "abc123",
"title": "abc123",
"voucherType": "abc123"
}
Response
{
"data": {
"voucherCampaignsAdd": {
"_id": "xyz789",
"attachment": Attachment,
"bonusCount": 123.45,
"bonusProductId": "abc123",
"buyScore": 987.65,
"coupon": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "abc123",
"lotteryCount": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"productCategoryIds": ["abc123"],
"productIds": ["xyz789"],
"score": 123.45,
"scoreAction": "xyz789",
"spinCampaignId": "xyz789",
"spinCount": 987.65,
"startDate": "2007-12-03",
"status": "abc123",
"title": "xyz789",
"voucherType": "abc123",
"vouchersCount": 123
}
}
}
voucherCampaignsEdit
Response
Returns a
VoucherCampaign
Arguments
| Name | Description |
|---|---|
_id -
String!
|
|
attachment -
AttachmentInput
|
|
bonusCount -
Float
|
|
bonusProductId -
String
|
|
buyScore -
Float
|
|
coupon -
String
|
|
description -
String
|
|
discountPercent -
Float
|
|
endDate -
Date
|
|
finishDateOfUse -
Date
|
|
lotteryCampaignId -
String
|
|
lotteryCount -
Float
|
|
productCategoryIds -
[String]
|
|
productIds -
[String]
|
|
score -
Float
|
|
scoreAction -
String
|
|
spinCampaignId -
String
|
|
spinCount -
Float
|
|
startDate -
Date
|
|
status -
String
|
|
title -
String
|
|
voucherType -
String
|
Example
Query
mutation VoucherCampaignsEdit(
$_id: String!,
$attachment: AttachmentInput,
$bonusCount: Float,
$bonusProductId: String,
$buyScore: Float,
$coupon: String,
$description: String,
$discountPercent: Float,
$endDate: Date,
$finishDateOfUse: Date,
$lotteryCampaignId: String,
$lotteryCount: Float,
$productCategoryIds: [String],
$productIds: [String],
$score: Float,
$scoreAction: String,
$spinCampaignId: String,
$spinCount: Float,
$startDate: Date,
$status: String,
$title: String,
$voucherType: String
) {
voucherCampaignsEdit(
_id: $_id,
attachment: $attachment,
bonusCount: $bonusCount,
bonusProductId: $bonusProductId,
buyScore: $buyScore,
coupon: $coupon,
description: $description,
discountPercent: $discountPercent,
endDate: $endDate,
finishDateOfUse: $finishDateOfUse,
lotteryCampaignId: $lotteryCampaignId,
lotteryCount: $lotteryCount,
productCategoryIds: $productCategoryIds,
productIds: $productIds,
score: $score,
scoreAction: $scoreAction,
spinCampaignId: $spinCampaignId,
spinCount: $spinCount,
startDate: $startDate,
status: $status,
title: $title,
voucherType: $voucherType
) {
_id
attachment {
duration
name
size
type
url
}
bonusCount
bonusProductId
buyScore
coupon
createdAt
createdBy
description
discountPercent
endDate
finishDateOfUse
lotteryCampaignId
lotteryCount
modifiedAt
modifiedBy
productCategoryIds
productIds
score
scoreAction
spinCampaignId
spinCount
startDate
status
title
voucherType
vouchersCount
}
}
Variables
{
"_id": "xyz789",
"attachment": AttachmentInput,
"bonusCount": 987.65,
"bonusProductId": "abc123",
"buyScore": 987.65,
"coupon": "abc123",
"description": "xyz789",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "abc123",
"lotteryCount": 987.65,
"productCategoryIds": ["abc123"],
"productIds": ["xyz789"],
"score": 123.45,
"scoreAction": "xyz789",
"spinCampaignId": "xyz789",
"spinCount": 123.45,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123",
"voucherType": "xyz789"
}
Response
{
"data": {
"voucherCampaignsEdit": {
"_id": "abc123",
"attachment": Attachment,
"bonusCount": 123.45,
"bonusProductId": "xyz789",
"buyScore": 987.65,
"coupon": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "xyz789",
"lotteryCount": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"productCategoryIds": ["abc123"],
"productIds": ["xyz789"],
"score": 987.65,
"scoreAction": "abc123",
"spinCampaignId": "abc123",
"spinCount": 123.45,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123",
"voucherType": "abc123",
"vouchersCount": 123
}
}
}
voucherCampaignsRemove
vouchersAdd
Response
Returns a
Voucher
Example
Query
mutation VouchersAdd(
$campaignId: String,
$ownerId: String,
$ownerType: String,
$status: String,
$usedAt: Date
) {
vouchersAdd(
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
status: $status,
usedAt: $usedAt
) {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
}
Variables
{
"campaignId": "xyz789",
"ownerId": "abc123",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"vouchersAdd": {
"_id": "abc123",
"bonusInfo": {},
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123"
}
}
}
vouchersEdit
Response
Returns a
Voucher
Example
Query
mutation VouchersEdit(
$_id: String!,
$campaignId: String,
$ownerId: String,
$ownerType: String,
$status: String,
$usedAt: Date
) {
vouchersEdit(
_id: $_id,
campaignId: $campaignId,
ownerId: $ownerId,
ownerType: $ownerType,
status: $status,
usedAt: $usedAt
) {
_id
bonusInfo
campaign
campaignId
createdAt
owner
ownerId
ownerType
status
usedAt
voucherCampaignId
}
}
Variables
{
"_id": "abc123",
"campaignId": "abc123",
"ownerId": "abc123",
"ownerType": "xyz789",
"status": "abc123",
"usedAt": "2007-12-03"
}
Response
{
"data": {
"vouchersEdit": {
"_id": "xyz789",
"bonusInfo": {},
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "abc123",
"ownerType": "xyz789",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789"
}
}
}
vouchersRemove
widgetBotRequest
Response
Returns a
JSON
Example
Query
mutation WidgetBotRequest(
$conversationId: String,
$customerId: String,
$integrationId: String!,
$message: String!,
$payload: String!,
$type: String!,
$visitorId: String
) {
widgetBotRequest(
conversationId: $conversationId,
customerId: $customerId,
integrationId: $integrationId,
message: $message,
payload: $payload,
type: $type,
visitorId: $visitorId
)
}
Variables
{
"conversationId": "xyz789",
"customerId": "xyz789",
"integrationId": "xyz789",
"message": "xyz789",
"payload": "abc123",
"type": "abc123",
"visitorId": "abc123"
}
Response
{"data": {"widgetBotRequest": {}}}
widgetGetBotInitialMessage
Example
Query
mutation WidgetGetBotInitialMessage($integrationId: String) {
widgetGetBotInitialMessage(integrationId: $integrationId)
}
Variables
{"integrationId": "xyz789"}
Response
{"data": {"widgetGetBotInitialMessage": {}}}
widgetsBookingConnect
Response
Returns an
Integration
Arguments
| Name | Description |
|---|---|
_id -
String
|
Example
Query
mutation WidgetsBookingConnect($_id: String) {
widgetsBookingConnect(_id: $_id) {
_id
bookingData {
bookingFormText
categoryTree
description
displayBlock
image {
...AttachmentFragment
}
mainProductCategory {
...ProductCategoryFragment
}
name
navigationText
productCategoryId
productFieldIds
style
userFilters
viewCount
}
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
brandId
channels {
_id
conversationCount
createdAt
description
integrationIds
integrations {
...IntegrationFragment
}
memberIds
members {
...UserFragment
}
name
openConversationCount
userId
}
code
departmentIds
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
languageCode
leadData
leadMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
messengerData
name
tagIds
tags {
_id
colorCode
createdAt
name
objectCount
order
parentId
relatedIds
totalObjectCount
type
}
uiOptions
visibility
webhookData
websiteMessengerApps {
_id
accountId
credentials
kind
name
showInInbox
}
}
}
Variables
{"_id": "abc123"}
Response
{
"data": {
"widgetsBookingConnect": {
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "abc123",
"channels": [Channel],
"code": "xyz789",
"departmentIds": ["xyz789"],
"form": Form,
"formId": "xyz789",
"healthStatus": {},
"isActive": true,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "xyz789",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "abc123",
"tagIds": ["xyz789"],
"tags": [Tag],
"uiOptions": {},
"visibility": "xyz789",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
}
}
widgetsInsertMessage
Response
Returns a
ConversationMessage
Example
Query
mutation WidgetsInsertMessage(
$attachments: [AttachmentInput],
$contentType: String,
$conversationId: String,
$customerId: String,
$integrationId: String!,
$message: String,
$skillId: String,
$visitorId: String
) {
widgetsInsertMessage(
attachments: $attachments,
contentType: $contentType,
conversationId: $conversationId,
customerId: $customerId,
integrationId: $integrationId,
message: $message,
skillId: $skillId,
visitorId: $visitorId
) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"attachments": [AttachmentInput],
"contentType": "xyz789",
"conversationId": "xyz789",
"customerId": "xyz789",
"integrationId": "xyz789",
"message": "abc123",
"skillId": "abc123",
"visitorId": "abc123"
}
Response
{
"data": {
"widgetsInsertMessage": {
"_id": "abc123",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "xyz789",
"contentType": "xyz789",
"conversationId": "abc123",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "xyz789",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": true,
"internal": true,
"isCustomerRead": true,
"mailData": MailData,
"mentionedUserIds": ["abc123"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
widgetsLeadConnect
Response
Returns a
FormConnectResponse
Example
Query
mutation WidgetsLeadConnect(
$brandCode: String!,
$cachedCustomerId: String,
$formCode: String!
) {
widgetsLeadConnect(
brandCode: $brandCode,
cachedCustomerId: $cachedCustomerId,
formCode: $formCode
) {
form {
_id
buttonText
code
createdDate
createdUser {
...UserFragment
}
createdUserId
description
fields {
...FieldFragment
}
googleMapApiKey
numberOfPages
title
type
}
integration {
_id
bookingData {
...BookingDataFragment
}
brand {
...BrandFragment
}
brandId
channels {
...ChannelFragment
}
code
departmentIds
form {
...FormFragment
}
formId
healthStatus
isActive
kind
knowledgeBaseMessengerApps {
...MessengerAppFragment
}
languageCode
leadData
leadMessengerApps {
...MessengerAppFragment
}
messengerData
name
tagIds
tags {
...TagFragment
}
uiOptions
visibility
webhookData
websiteMessengerApps {
...MessengerAppFragment
}
}
}
}
Variables
{
"brandCode": "abc123",
"cachedCustomerId": "xyz789",
"formCode": "abc123"
}
Response
{
"data": {
"widgetsLeadConnect": {
"form": Form,
"integration": Integration
}
}
}
widgetsLeadIncreaseViewCount
widgetsMessengerConnect
Response
Returns a
MessengerConnectResponse
Example
Query
mutation WidgetsMessengerConnect(
$brandCode: String!,
$cachedCustomerId: String,
$code: String,
$companyData: JSON,
$data: JSON,
$deviceToken: String,
$email: String,
$isUser: Boolean,
$phone: String,
$visitorId: String
) {
widgetsMessengerConnect(
brandCode: $brandCode,
cachedCustomerId: $cachedCustomerId,
code: $code,
companyData: $companyData,
data: $data,
deviceToken: $deviceToken,
email: $email,
isUser: $isUser,
phone: $phone,
visitorId: $visitorId
) {
brand {
_id
code
createdAt
description
emailConfig
name
userId
}
customerId
integrationId
languageCode
messengerData
uiOptions
visitorId
}
}
Variables
{
"brandCode": "xyz789",
"cachedCustomerId": "xyz789",
"code": "abc123",
"companyData": {},
"data": {},
"deviceToken": "xyz789",
"email": "abc123",
"isUser": true,
"phone": "xyz789",
"visitorId": "xyz789"
}
Response
{
"data": {
"widgetsMessengerConnect": {
"brand": Brand,
"customerId": "xyz789",
"integrationId": "xyz789",
"languageCode": "abc123",
"messengerData": {},
"uiOptions": {},
"visitorId": "abc123"
}
}
}
widgetsReadConversationMessages
Example
Query
mutation WidgetsReadConversationMessages($conversationId: String) {
widgetsReadConversationMessages(conversationId: $conversationId)
}
Variables
{"conversationId": "xyz789"}
Response
{"data": {"widgetsReadConversationMessages": {}}}
widgetsSaveBooking
Response
Returns a
SaveFormResponse
Example
Query
mutation WidgetsSaveBooking(
$browserInfo: JSON!,
$cachedCustomerId: String,
$formId: String!,
$integrationId: String!,
$productId: String,
$submissions: [FieldValueInput]
) {
widgetsSaveBooking(
browserInfo: $browserInfo,
cachedCustomerId: $cachedCustomerId,
formId: $formId,
integrationId: $integrationId,
productId: $productId,
submissions: $submissions
) {
customerId
errors {
code
fieldId
text
}
invoiceResponse
invoiceType
messageId
status
userId
}
}
Variables
{
"browserInfo": {},
"cachedCustomerId": "xyz789",
"formId": "xyz789",
"integrationId": "abc123",
"productId": "xyz789",
"submissions": [FieldValueInput]
}
Response
{
"data": {
"widgetsSaveBooking": {
"customerId": "abc123",
"errors": [Error],
"invoiceResponse": "xyz789",
"invoiceType": "abc123",
"messageId": "abc123",
"status": "xyz789",
"userId": "abc123"
}
}
}
widgetsSaveBrowserInfo
Response
Returns a
ConversationMessage
Example
Query
mutation WidgetsSaveBrowserInfo(
$browserInfo: JSON!,
$customerId: String,
$visitorId: String
) {
widgetsSaveBrowserInfo(
browserInfo: $browserInfo,
customerId: $customerId,
visitorId: $visitorId
) {
_id
attachments {
duration
name
size
type
url
}
bookingWidgetData
botData
content
contentType
conversationId
createdAt
customer {
_id
avatar
birthDate
code
companies {
...CompanyFragment
}
conversations {
...ConversationFragment
}
createdAt
customFieldsData
department
description
email
emailValidationStatus
emails
firstName
getTags {
...TagFragment
}
hasAuthority
integration {
...IntegrationFragment
}
integrationId
isOnline
isSubscribed
lastName
lastSeenAt
leadStatus
links
location
middleName
modifiedAt
owner {
...UserFragment
}
ownerId
phone
phoneValidationStatus
phones
position
primaryEmail
primaryPhone
remoteAddress
score
sessionCount
sex
state
tagIds
trackedData
urlVisits
visitorContactInfo
}
customerId
engageData {
brandId
content
fromUser {
...UserFragment
}
fromUserId
kind
messageId
sentAs
}
formWidgetData
fromBot
internal
isCustomerRead
mailData {
accountId
attachments {
...MailAttachmentFragment
}
bcc {
...EmailFragment
}
body
cc {
...EmailFragment
}
from {
...EmailFragment
}
headerId
inReplyTo
integrationEmail
messageId
references
replyTo
replyToMessageId
subject
threadId
to {
...EmailFragment
}
}
mentionedUserIds
messengerAppData
user {
_id
brandIds
brands {
...BrandFragment
}
configs
configsConstants
createdAt
customFieldsData
department {
...DepartmentFragment
}
details {
...UserDetailsTypeFragment
}
email
emailSignatures
getNotificationByEmail
groupIds
isActive
isOwner
isShowNotification
isSubscribed
leaderBoardPosition
links
onboardingHistory {
...OnboardingHistoryFragment
}
permissionActions
score
status
username
}
userId
videoCallData {
name
recordingLinks
status
url
}
}
}
Variables
{
"browserInfo": {},
"customerId": "abc123",
"visitorId": "abc123"
}
Response
{
"data": {
"widgetsSaveBrowserInfo": {
"_id": "abc123",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "xyz789",
"contentType": "xyz789",
"conversationId": "abc123",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "abc123",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": true,
"internal": true,
"isCustomerRead": false,
"mailData": MailData,
"mentionedUserIds": ["abc123"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
}
}
widgetsSaveCustomerGetNotified
Response
Returns a
JSON
Example
Query
mutation WidgetsSaveCustomerGetNotified(
$customerId: String,
$type: String!,
$value: String!,
$visitorId: String
) {
widgetsSaveCustomerGetNotified(
customerId: $customerId,
type: $type,
value: $value,
visitorId: $visitorId
)
}
Variables
{
"customerId": "xyz789",
"type": "xyz789",
"value": "xyz789",
"visitorId": "abc123"
}
Response
{"data": {"widgetsSaveCustomerGetNotified": {}}}
widgetsSaveLead
Response
Returns a
SaveFormResponse
Example
Query
mutation WidgetsSaveLead(
$browserInfo: JSON!,
$cachedCustomerId: String,
$formId: String!,
$integrationId: String!,
$submissions: [FieldValueInput],
$userId: String
) {
widgetsSaveLead(
browserInfo: $browserInfo,
cachedCustomerId: $cachedCustomerId,
formId: $formId,
integrationId: $integrationId,
submissions: $submissions,
userId: $userId
) {
customerId
errors {
code
fieldId
text
}
invoiceResponse
invoiceType
messageId
status
userId
}
}
Variables
{
"browserInfo": {},
"cachedCustomerId": "abc123",
"formId": "xyz789",
"integrationId": "xyz789",
"submissions": [FieldValueInput],
"userId": "abc123"
}
Response
{
"data": {
"widgetsSaveLead": {
"customerId": "abc123",
"errors": [Error],
"invoiceResponse": "abc123",
"invoiceType": "xyz789",
"messageId": "abc123",
"status": "abc123",
"userId": "xyz789"
}
}
}
widgetsSendEmail
Response
Returns a
String
Example
Query
mutation WidgetsSendEmail(
$attachments: [AttachmentInput],
$content: String,
$customerId: String,
$formId: String,
$fromEmail: String,
$title: String,
$toEmails: [String]
) {
widgetsSendEmail(
attachments: $attachments,
content: $content,
customerId: $customerId,
formId: $formId,
fromEmail: $fromEmail,
title: $title,
toEmails: $toEmails
)
}
Variables
{
"attachments": [AttachmentInput],
"content": "abc123",
"customerId": "abc123",
"formId": "xyz789",
"fromEmail": "abc123",
"title": "abc123",
"toEmails": ["xyz789"]
}
Response
{"data": {"widgetsSendEmail": "abc123"}}
widgetsSendTypingInfo
Example
Query
mutation WidgetsSendTypingInfo(
$conversationId: String!,
$text: String
) {
widgetsSendTypingInfo(
conversationId: $conversationId,
text: $text
)
}
Variables
{
"conversationId": "abc123",
"text": "xyz789"
}
Response
{
"data": {
"widgetsSendTypingInfo": "abc123"
}
}
Types
Action
Example
{
"config": {},
"description": "abc123",
"icon": "xyz789",
"id": "xyz789",
"label": "xyz789",
"nextActionId": "abc123",
"style": {},
"type": "xyz789"
}
ActionInput
Example
{
"config": {},
"description": "abc123",
"icon": "abc123",
"id": "abc123",
"label": "abc123",
"nextActionId": "xyz789",
"style": {},
"type": "xyz789"
}
ActivityLog
Example
{
"_id": "xyz789",
"action": "xyz789",
"content": {},
"contentDetail": {},
"contentId": "abc123",
"contentType": "xyz789",
"contentTypeDetail": {},
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"createdByDetail": {}
}
ActivityLogByAction
Example
{
"_id": "abc123",
"action": "xyz789",
"content": {},
"contentId": "xyz789",
"contentType": "xyz789",
"contentTypeDetail": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User
}
ActivityLogByActionResponse
Fields
| Field Name | Description |
|---|---|
activityLogs -
[ActivityLogByAction]
|
|
totalCount -
Int
|
Example
{"activityLogs": [ActivityLogByAction], "totalCount": 123}
App
Example
{
"_id": "abc123",
"accessToken": "abc123",
"createdAt": "2007-12-03",
"expireDate": "2007-12-03",
"isEnabled": false,
"name": "xyz789",
"refreshToken": "xyz789",
"userGroupId": "xyz789",
"userGroupName": "abc123"
}
Attachment
AttachmentInput
Automation
Example
{
"_id": "abc123",
"actions": [Action],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"name": "xyz789",
"status": "abc123",
"triggers": [Trigger],
"updatedAt": "2007-12-03",
"updatedBy": "abc123",
"updatedUser": User
}
AutomationHistory
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
actions -
[JSON]
|
|
automationId -
String
|
|
createdAt -
Date
|
|
description -
String
|
|
modifiedAt -
Date
|
|
nextActionId -
String
|
|
startWaitingDate -
Date
|
|
status -
String
|
|
target -
JSON
|
|
targetId -
String
|
|
triggerConfig -
JSON
|
|
triggerId -
String
|
|
triggerType -
String
|
|
waitingActionId -
String
|
Example
{
"_id": "xyz789",
"actions": [{}],
"automationId": "xyz789",
"createdAt": "2007-12-03",
"description": "abc123",
"modifiedAt": "2007-12-03",
"nextActionId": "abc123",
"startWaitingDate": "2007-12-03",
"status": "xyz789",
"target": {},
"targetId": "abc123",
"triggerConfig": {},
"triggerId": "abc123",
"triggerType": "xyz789",
"waitingActionId": "abc123"
}
AutomationNote
AutomationsListResponse
Fields
| Field Name | Description |
|---|---|
list -
[Automation]
|
|
totalCount -
Float
|
Example
{"list": [Automation], "totalCount": 987.65}
AvgEmailStats
Example
{
"avgBouncePercent": 123.45,
"avgClickPercent": 123.45,
"avgComplaintPercent": 123.45,
"avgDeliveryPercent": 123.45,
"avgOpenPercent": 123.45,
"avgRejectPercent": 123.45,
"avgRenderingFailurePercent": 987.65,
"avgSendPercent": 987.65,
"total": 123.45
}
Board
BoardCount
BookingData
Fields
| Field Name | Description |
|---|---|
bookingFormText -
String
|
|
categoryTree -
JSON
|
|
description -
String
|
|
displayBlock -
JSON
|
|
image -
Attachment
|
|
mainProductCategory -
ProductCategory
|
|
name -
String
|
|
navigationText -
String
|
|
productCategoryId -
String
|
|
productFieldIds -
[String]
|
|
style -
JSON
|
|
userFilters -
[String]
|
|
viewCount -
Int
|
Example
{
"bookingFormText": "abc123",
"categoryTree": {},
"description": "abc123",
"displayBlock": {},
"image": Attachment,
"mainProductCategory": ProductCategory,
"name": "abc123",
"navigationText": "abc123",
"productCategoryId": "abc123",
"productFieldIds": ["abc123"],
"style": {},
"userFilters": ["xyz789"],
"viewCount": 987
}
BookingProduct
BookingStyleInput
Example
{
"baseFont": "abc123",
"columns": 987,
"itemShape": "abc123",
"line": "xyz789",
"margin": 123,
"productAvailable": "abc123",
"rows": 987,
"widgetColor": "xyz789"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Branch
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
address -
String
|
|
children -
[Branch]
|
|
code -
String
|
|
coordinate -
Coordinate
|
|
email -
String
|
|
image -
Attachment
|
|
links -
JSON
|
|
parent -
Branch
|
|
parentId -
String
|
|
phoneNumber -
String
|
|
supervisor -
User
|
|
supervisorId -
String
|
|
title -
String
|
|
userIds -
[String]
|
|
users -
[User]
|
Example
{
"_id": "xyz789",
"address": "xyz789",
"children": [Branch],
"code": "xyz789",
"coordinate": Coordinate,
"email": "abc123",
"image": Attachment,
"links": {},
"parent": Branch,
"parentId": "xyz789",
"phoneNumber": "abc123",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userIds": ["abc123"],
"users": [User]
}
Brand
Channel
Example
{
"_id": "xyz789",
"conversationCount": 987,
"createdAt": "2007-12-03",
"description": "abc123",
"integrationIds": ["abc123"],
"integrations": [Integration],
"memberIds": ["xyz789"],
"members": [User],
"name": "xyz789",
"openConversationCount": 123,
"userId": "abc123"
}
Chat
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
description -
String
|
|
isSeen -
Boolean
|
|
lastMessage -
ChatMessage
|
|
name -
String
|
|
participantUsers -
[ChatUser]
|
|
type -
String
|
|
visibility -
String
|
Example
{
"_id": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "abc123",
"isSeen": false,
"lastMessage": ChatMessage,
"name": "xyz789",
"participantUsers": [ChatUser],
"type": "xyz789",
"visibility": "xyz789"
}
ChatMemberModifyType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"add"
ChatMessage
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
attachments -
JSON
|
|
content -
String
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
isPinned -
Boolean
|
|
mentionedUserIds -
[String]
|
|
relatedMessage -
ChatMessage
|
|
seenList -
[SeenInfo]
|
Example
{
"_id": "xyz789",
"attachments": {},
"content": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"isPinned": true,
"mentionedUserIds": ["abc123"],
"relatedMessage": ChatMessage,
"seenList": [SeenInfo]
}
ChatMessageResponse
Fields
| Field Name | Description |
|---|---|
list -
[ChatMessage]
|
|
totalCount -
Int
|
Example
{"list": [ChatMessage], "totalCount": 123}
ChatResponse
ChatType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"direct"
ChatUser
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
details -
ChatUserDetails
|
|
email -
String
|
|
isAdmin -
Boolean
|
|
username -
String
|
Example
{
"_id": "abc123",
"details": ChatUserDetails,
"email": "xyz789",
"isAdmin": false,
"username": "xyz789"
}
ChatUserDetails
ChatVisibilityType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"private"
Checklist
Example
{
"_id": "xyz789",
"contentType": "xyz789",
"contentTypeId": "abc123",
"createdDate": "2007-12-03",
"createdUserId": "abc123",
"items": [ChecklistItem],
"percent": 987.65,
"title": "abc123"
}
ChecklistItem
ClientPortal
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
description -
String
|
|
dnsStatus -
String
|
|
domain -
String
|
|
footerHtml -
String
|
|
googleCredentials -
JSON
|
|
headerHtml -
String
|
|
icon -
String
|
|
kbToggle -
Boolean
|
|
knowledgeBaseLabel -
String
|
|
knowledgeBaseTopicId -
String
|
|
logo -
String
|
|
messengerBrandCode -
String
|
|
mobileResponsive -
Boolean
|
|
name -
String!
|
|
otpConfig -
OTPConfig
|
|
publicTaskToggle -
Boolean
|
|
styles -
Styles
|
|
taskBoardId -
String
|
|
taskLabel -
String
|
|
taskPipelineId -
String
|
|
taskPublicBoardId -
String
|
|
taskPublicPipelineId -
String
|
|
taskStageId -
String
|
|
taskToggle -
Boolean
|
|
ticketBoardId -
String
|
|
ticketLabel -
String
|
|
ticketPipelineId -
String
|
|
ticketStageId -
String
|
|
ticketToggle -
Boolean
|
|
url -
String
|
Example
{
"_id": "xyz789",
"description": "abc123",
"dnsStatus": "xyz789",
"domain": "xyz789",
"footerHtml": "abc123",
"googleCredentials": {},
"headerHtml": "xyz789",
"icon": "abc123",
"kbToggle": true,
"knowledgeBaseLabel": "xyz789",
"knowledgeBaseTopicId": "xyz789",
"logo": "abc123",
"messengerBrandCode": "abc123",
"mobileResponsive": true,
"name": "abc123",
"otpConfig": OTPConfig,
"publicTaskToggle": false,
"styles": Styles,
"taskBoardId": "xyz789",
"taskLabel": "abc123",
"taskPipelineId": "abc123",
"taskPublicBoardId": "abc123",
"taskPublicPipelineId": "xyz789",
"taskStageId": "xyz789",
"taskToggle": false,
"ticketBoardId": "xyz789",
"ticketLabel": "abc123",
"ticketPipelineId": "abc123",
"ticketStageId": "abc123",
"ticketToggle": false,
"url": "abc123"
}
ClientPortalUser
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
clientPortalId -
String
|
|
code -
String
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
email -
String
|
|
erxesCustomerId -
String
|
|
firstName -
String
|
|
lastName -
String
|
|
links -
JSON
|
|
modifiedAt -
Date
|
|
ownerId -
String
|
|
password -
String
|
|
phone -
String
|
|
type -
String
|
|
username -
String
|
Example
{
"_id": "xyz789",
"clientPortalId": "abc123",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"email": "xyz789",
"erxesCustomerId": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"links": {},
"modifiedAt": "2007-12-03",
"ownerId": "xyz789",
"password": "xyz789",
"phone": "abc123",
"type": "xyz789",
"username": "abc123"
}
ColumnConfigItem
Comment
Example
{
"_id": "xyz789",
"childCount": 987,
"comment": "abc123",
"contentId": "xyz789",
"contentType": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"parentId": "xyz789",
"updatedAt": "2007-12-03"
}
CommentResponse
CommonInput
Fields
| Input Field | Description |
|---|---|
district -
String
|
|
khoroo -
String
|
|
locationValue -
LocationInput
|
Example
{
"district": "abc123",
"khoroo": "abc123",
"locationValue": LocationInput
}
CompaniesListResponse
Company
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
avatar -
String
|
|
businessType -
String
|
|
code -
String
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
customers -
[Customer]
|
|
description -
String
|
|
emails -
[String]
|
|
getTags -
[Tag]
|
|
industry -
String
|
|
isSubscribed -
String
|
|
links -
JSON
|
|
location -
String
|
|
mergedIds -
[String]
|
|
modifiedAt -
Date
|
|
names -
[String]
|
|
owner -
User
|
|
ownerId -
String
|
|
parentCompany -
Company
|
|
parentCompanyId -
String
|
|
phones -
[String]
|
|
plan -
String
|
|
primaryEmail -
String
|
|
primaryName -
String
|
|
primaryPhone -
String
|
|
score -
Float
|
|
size -
Int
|
|
tagIds -
[String]
|
|
trackedData -
JSON
|
|
website -
String
|
Example
{
"_id": "abc123",
"avatar": "abc123",
"businessType": "xyz789",
"code": "xyz789",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"emails": ["abc123"],
"getTags": [Tag],
"industry": "xyz789",
"isSubscribed": "abc123",
"links": {},
"location": "abc123",
"mergedIds": ["xyz789"],
"modifiedAt": "2007-12-03",
"names": ["xyz789"],
"owner": User,
"ownerId": "xyz789",
"parentCompany": Company,
"parentCompanyId": "abc123",
"phones": ["xyz789"],
"plan": "abc123",
"primaryEmail": "abc123",
"primaryName": "xyz789",
"primaryPhone": "abc123",
"score": 987.65,
"size": 123,
"tagIds": ["abc123"],
"trackedData": {},
"website": "xyz789"
}
Config
Conformity
ContentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"birthday"
Conversation
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
assignedUser -
User
|
|
assignedUserId -
String
|
|
bookingProductId -
String
|
|
callProAudio -
String
|
|
content -
String
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
customer -
Customer
|
|
customerId -
String
|
|
facebookPost -
FacebookPost
|
|
idleTime -
Float
|
|
integration -
Integration
|
|
integrationId -
String
|
|
isFacebookTaggedMessage -
Boolean
|
|
messageCount -
Int
|
|
messages -
[ConversationMessage]
|
|
number -
Int
|
|
operatorStatus -
String
|
|
participatedUserIds -
[String]
|
|
participatedUsers -
[User]
|
|
participatorCount -
Int
|
|
readUserIds -
[String]
|
|
status -
String
|
|
tagIds -
[String]
|
|
tags -
[Tag]
|
|
updatedAt -
Date
|
|
user -
User
|
|
userId -
String
|
|
videoCallData -
VideoCallData
|
Example
{
"_id": "abc123",
"assignedUser": User,
"assignedUserId": "abc123",
"bookingProductId": "abc123",
"callProAudio": "abc123",
"content": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"facebookPost": FacebookPost,
"idleTime": 123.45,
"integration": Integration,
"integrationId": "xyz789",
"isFacebookTaggedMessage": true,
"messageCount": 123,
"messages": [ConversationMessage],
"number": 123,
"operatorStatus": "xyz789",
"participatedUserIds": ["xyz789"],
"participatedUsers": [User],
"participatorCount": 987,
"readUserIds": ["abc123"],
"status": "xyz789",
"tagIds": ["xyz789"],
"tags": [Tag],
"updatedAt": "2007-12-03",
"user": User,
"userId": "xyz789",
"videoCallData": VideoCallData
}
ConversationDetailResponse
Example
{
"_id": "abc123",
"isOnline": true,
"messages": [ConversationMessage],
"operatorStatus": "abc123",
"participatedUsers": [User],
"supporters": [User]
}
ConversationMessage
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
attachments -
[Attachment]
|
|
bookingWidgetData -
JSON
|
|
botData -
JSON
|
|
content -
String
|
|
contentType -
String
|
|
conversationId -
String
|
|
createdAt -
Date
|
|
customer -
Customer
|
|
customerId -
String
|
|
engageData -
EngageData
|
|
formWidgetData -
JSON
|
|
fromBot -
Boolean
|
|
internal -
Boolean
|
|
isCustomerRead -
Boolean
|
|
mailData -
MailData
|
|
mentionedUserIds -
[String]
|
|
messengerAppData -
JSON
|
|
user -
User
|
|
userId -
String
|
|
videoCallData -
VideoCallData
|
Example
{
"_id": "xyz789",
"attachments": [Attachment],
"bookingWidgetData": {},
"botData": {},
"content": "abc123",
"contentType": "xyz789",
"conversationId": "xyz789",
"createdAt": "2007-12-03",
"customer": Customer,
"customerId": "abc123",
"engageData": EngageData,
"formWidgetData": {},
"fromBot": false,
"internal": true,
"isCustomerRead": false,
"mailData": MailData,
"mentionedUserIds": ["xyz789"],
"messengerAppData": {},
"user": User,
"userId": "abc123",
"videoCallData": VideoCallData
}
ConvertTo
Coordinate
CoordinateInput
Customer
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
avatar -
String
|
|
birthDate -
Date
|
|
code -
String
|
|
companies -
[Company]
|
|
conversations -
[Conversation]
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
department -
String
|
|
description -
String
|
|
email -
String
|
|
emailValidationStatus -
String
|
|
emails -
[String]
|
|
firstName -
String
|
|
getTags -
[Tag]
|
|
hasAuthority -
String
|
|
integration -
Integration
|
|
integrationId -
String
|
|
isOnline -
Boolean
|
|
isSubscribed -
String
|
|
lastName -
String
|
|
lastSeenAt -
Date
|
|
leadStatus -
String
|
|
links -
JSON
|
|
location -
JSON
|
|
middleName -
String
|
|
modifiedAt -
Date
|
|
owner -
User
|
|
ownerId -
String
|
|
phone -
String
|
|
phoneValidationStatus -
String
|
|
phones -
[String]
|
|
position -
String
|
|
primaryEmail -
String
|
|
primaryPhone -
String
|
|
remoteAddress -
String
|
|
score -
Float
|
|
sessionCount -
Int
|
|
sex -
Int
|
|
state -
String
|
|
tagIds -
[String]
|
|
trackedData -
JSON
|
|
urlVisits -
[JSON]
|
|
visitorContactInfo -
JSON
|
Example
{
"_id": "abc123",
"avatar": "xyz789",
"birthDate": "2007-12-03",
"code": "xyz789",
"companies": [Company],
"conversations": [Conversation],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": "xyz789",
"description": "xyz789",
"email": "xyz789",
"emailValidationStatus": "abc123",
"emails": ["xyz789"],
"firstName": "xyz789",
"getTags": [Tag],
"hasAuthority": "abc123",
"integration": Integration,
"integrationId": "abc123",
"isOnline": false,
"isSubscribed": "abc123",
"lastName": "xyz789",
"lastSeenAt": "2007-12-03",
"leadStatus": "abc123",
"links": {},
"location": {},
"middleName": "xyz789",
"modifiedAt": "2007-12-03",
"owner": User,
"ownerId": "xyz789",
"phone": "xyz789",
"phoneValidationStatus": "xyz789",
"phones": ["abc123"],
"position": "abc123",
"primaryEmail": "abc123",
"primaryPhone": "abc123",
"remoteAddress": "abc123",
"score": 123.45,
"sessionCount": 123,
"sex": 987,
"state": "abc123",
"tagIds": ["xyz789"],
"trackedData": {},
"urlVisits": [{}],
"visitorContactInfo": {}
}
CustomersListResponse
Fields
| Field Name | Description |
|---|---|
list -
[Customer]
|
|
totalCount -
Float
|
Example
{"list": [Customer], "totalCount": 987.65}
Dashboard
Example
{
"_id": "xyz789",
"childsDashboard": [Dashboard],
"createdAt": "2007-12-03",
"dashboardCount": 123,
"description": "abc123",
"name": "abc123",
"order": "xyz789",
"parentId": "xyz789",
"relatedIds": ["abc123"],
"selectedMemberIds": ["xyz789"],
"visibility": "xyz789"
}
DashboardItem
Example
{
"_id": "xyz789",
"dashboardId": "xyz789",
"isDateRange": false,
"layout": "xyz789",
"name": "abc123",
"type": "xyz789",
"vizState": "abc123"
}
Date
Description
Date custom scalar type
Example
"2007-12-03"
Deal
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
amount -
JSON
|
|
assignedUserIds -
[String]
|
|
assignedUsers -
[User]
|
|
attachments -
[Attachment]
|
|
boardId -
String
|
|
closeDate -
Date
|
|
companies -
[Company]
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
customFieldsData -
JSON
|
|
customers -
[Customer]
|
|
description -
String
|
|
hasNotified -
Boolean
|
|
isComplete -
Boolean
|
|
isWatched -
Boolean
|
|
labelIds -
[String]
|
|
labels -
[PipelineLabel]
|
|
modifiedAt -
Date
|
|
modifiedBy -
String
|
|
name -
String!
|
|
number -
String
|
|
order -
Float
|
|
paymentsData -
JSON
|
|
pipeline -
Pipeline
|
|
priority -
String
|
|
products -
JSON
|
|
productsData -
JSON
|
|
reminderMinute -
Int
|
|
score -
Float
|
|
stage -
Stage
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
|
timeTrack -
TimeTrack
|
|
userId -
String
|
Example
{
"_id": "abc123",
"amount": {},
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "abc123",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": false,
"isComplete": false,
"isWatched": true,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "abc123",
"number": "abc123",
"order": 123.45,
"paymentsData": {},
"pipeline": Pipeline,
"priority": "xyz789",
"products": {},
"productsData": {},
"reminderMinute": 123,
"score": 123.45,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
DealListItem
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
amount -
JSON
|
|
assignedUsers -
JSON
|
|
closeDate -
Date
|
|
companies -
JSON
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
customers -
JSON
|
|
hasNotified -
Boolean
|
|
isComplete -
Boolean
|
|
isWatched -
Boolean
|
|
labels -
JSON
|
|
modifiedAt -
Date
|
|
name -
String
|
|
number -
String
|
|
priority -
String
|
|
products -
JSON
|
|
relations -
JSON
|
|
score -
Float
|
|
stage -
JSON
|
|
startDate -
Date
|
Example
{
"_id": "xyz789",
"amount": {},
"assignedUsers": {},
"closeDate": "2007-12-03",
"companies": {},
"createdAt": "2007-12-03",
"customFieldsData": {},
"customers": {},
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labels": {},
"modifiedAt": "2007-12-03",
"name": "abc123",
"number": "xyz789",
"priority": "abc123",
"products": {},
"relations": {},
"score": 123.45,
"stage": {},
"startDate": "2007-12-03"
}
DealTotalCurrency
DeliveryList
Fields
| Field Name | Description |
|---|---|
list -
[SmsDelivery]
|
|
totalCount -
Int
|
Example
{"list": [SmsDelivery], "totalCount": 987}
DeliveryReport
Example
{
"_id": "abc123",
"createdAt": "2007-12-03",
"customerId": "abc123",
"customerName": "xyz789",
"engage": EngageMessage,
"mailId": "xyz789",
"status": "xyz789"
}
Department
Example
{
"_id": "abc123",
"childCount": 123,
"children": [Department],
"code": "xyz789",
"description": "xyz789",
"parent": Department,
"parentId": "abc123",
"supervisor": User,
"supervisorId": "xyz789",
"title": "xyz789",
"userCount": 123,
"userIds": ["abc123"],
"users": [User]
}
DistrictTownInput
Fields
| Input Field | Description |
|---|---|
averageAge -
Float
|
|
averageM2 -
Float
|
|
averagePrice -
String
|
|
districtProfile -
String
|
|
districtProfileAttachment -
[JSON]
|
|
featuredAds -
String
|
|
featuredAdsAttachment -
[JSON]
|
|
market -
String
|
|
marketAttachment -
[JSON]
|
|
population -
Float
|
|
publicService -
String
|
|
publicServiceAttachment -
[JSON]
|
Example
{
"averageAge": 123.45,
"averageM2": 987.65,
"averagePrice": "xyz789",
"districtProfile": "abc123",
"districtProfileAttachment": [{}],
"featuredAds": "xyz789",
"featuredAdsAttachment": [{}],
"market": "xyz789",
"marketAttachment": [{}],
"population": 987.65,
"publicService": "xyz789",
"publicServiceAttachment": [{}]
}
Donate
Example
{
"_id": "abc123",
"awardId": "xyz789",
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"donateScore": 123.45,
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
DonateCampaign
Example
{
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"donatesCount": 987,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"maxScore": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"title": "abc123"
}
DonateMain
ENV
Fields
| Field Name | Description |
|---|---|
USE_BRAND_RESTRICTIONS -
String
|
Example
{"USE_BRAND_RESTRICTIONS": "xyz789"}
Fields
| Field Name | Description |
|---|---|
email -
String
|
Example
{"email": "xyz789"}
EmailDelivery
Example
{
"_id": "abc123",
"attachments": [{}],
"bcc": ["xyz789"],
"body": "xyz789",
"cc": ["xyz789"],
"createdAt": "2007-12-03",
"customerId": "xyz789",
"from": "xyz789",
"fromEmail": "xyz789",
"fromUser": User,
"kind": "abc123",
"status": "abc123",
"subject": "xyz789",
"to": ["xyz789"],
"userId": "abc123"
}
EmailDeliveryList
Fields
| Field Name | Description |
|---|---|
list -
[EmailDelivery]
|
|
totalCount -
Int
|
Example
{"list": [EmailDelivery], "totalCount": 123}
EmailSignature
EmailTemplate
Example
{
"_id": "abc123",
"content": "xyz789",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUser": User,
"modifiedAt": "2007-12-03",
"name": "xyz789",
"status": "abc123"
}
EngageData
Example
{
"brandId": "xyz789",
"content": "xyz789",
"fromUser": User,
"fromUserId": "xyz789",
"kind": "abc123",
"messageId": "abc123",
"sentAs": "xyz789"
}
EngageDeliveryReport
Fields
| Field Name | Description |
|---|---|
list -
[DeliveryReport]
|
|
totalCount -
Int
|
Example
{"list": [DeliveryReport], "totalCount": 987}
EngageLog
EngageMessage
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
brand -
Brand
|
|
brandIds -
[String]
|
|
brands -
[Brand]
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
createdUserName -
String
|
|
customerIds -
[String]
|
|
customerTagIds -
[String]
|
|
customerTags -
[Tag]
|
|
email -
JSON
|
|
fromIntegration -
JSON
|
|
fromUser -
User
|
|
fromUserId -
String
|
|
getTags -
[Tag]
|
|
isDraft -
Boolean
|
|
isLive -
Boolean
|
|
kind -
String
|
|
lastRunAt -
Date
|
|
logs -
[EngageLog]
|
|
messenger -
JSON
|
|
messengerReceivedCustomerIds -
[String]
|
|
method -
String
|
|
runCount -
Int
|
|
scheduleDate -
EngageScheduleDate
|
|
segmentIds -
[String]
|
|
segments -
[Segment]
|
|
shortMessage -
EngageMessageSms
|
|
smsStats -
JSON
|
|
stats -
JSON
|
|
stopDate -
Date
|
|
tagIds -
[String]
|
|
title -
String
|
|
totalCustomersCount -
Int
|
|
type -
String
|
|
validCustomersCount -
Int
|
Example
{
"_id": "xyz789",
"brand": Brand,
"brandIds": ["abc123"],
"brands": [Brand],
"createdAt": "2007-12-03",
"createdBy": "abc123",
"createdUserName": "xyz789",
"customerIds": ["xyz789"],
"customerTagIds": ["abc123"],
"customerTags": [Tag],
"email": {},
"fromIntegration": {},
"fromUser": User,
"fromUserId": "xyz789",
"getTags": [Tag],
"isDraft": true,
"isLive": true,
"kind": "xyz789",
"lastRunAt": "2007-12-03",
"logs": [EngageLog],
"messenger": {},
"messengerReceivedCustomerIds": [
"xyz789"
],
"method": "abc123",
"runCount": 123,
"scheduleDate": EngageScheduleDate,
"segmentIds": ["abc123"],
"segments": [Segment],
"shortMessage": EngageMessageSms,
"smsStats": {},
"stats": {},
"stopDate": "2007-12-03",
"tagIds": ["xyz789"],
"title": "xyz789",
"totalCustomersCount": 123,
"type": "xyz789",
"validCustomersCount": 123
}
EngageMessageEmail
EngageMessageMessenger
Fields
| Input Field | Description |
|---|---|
brandId -
String!
|
|
content -
String
|
|
kind -
String
|
|
rules -
[InputRule]
|
|
sentAs -
String
|
Example
{
"brandId": "abc123",
"content": "abc123",
"kind": "abc123",
"rules": [InputRule],
"sentAs": "xyz789"
}
EngageMessageSms
EngageMessageSmsInput
EngageScheduleDate
EngageScheduleDateInput
EnvInfoInput
Error
EventAttributeFilter
Exm
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
appearance -
ExmAppearance
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
description -
String
|
|
features -
[ExmFeature]
|
|
logo -
JSON
|
|
name -
String
|
|
welcomeContent -
[ExmWelcomeContent]
|
Example
{
"_id": "xyz789",
"appearance": ExmAppearance,
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"features": [ExmFeature],
"logo": {},
"name": "xyz789",
"welcomeContent": [ExmWelcomeContent]
}
ExmAppearance
ExmAppearanceInput
ExmCeremonyData
ExmEventData
Example
{
"endDate": "2007-12-03",
"goingUserIds": ["xyz789"],
"interestedUserIds": ["xyz789"],
"startDate": "2007-12-03",
"visibility": "abc123",
"where": "abc123"
}
ExmEventDataInput
ExmFeature
Example
{
"_id": "xyz789",
"contentId": "abc123",
"contentType": "abc123",
"description": "xyz789",
"icon": "xyz789",
"name": "abc123",
"subContentId": "xyz789"
}
ExmFeatureInput
Example
{
"_id": "xyz789",
"contentId": "abc123",
"contentType": "xyz789",
"description": "abc123",
"icon": "abc123",
"name": "abc123",
"subContentId": "xyz789"
}
ExmFeed
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
attachments -
JSON
|
|
ceremonyData -
ExmCeremonyData
|
|
commentCount -
Int
|
|
contentType -
String
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
endDate -
Date
|
|
eventData -
ExmEventData
|
|
eventGoingUsers -
[User]
|
|
eventInterestedUsers -
[User]
|
|
heartCount -
Int
|
|
images -
JSON
|
|
isHearted -
Boolean
|
|
isLiked -
Boolean
|
|
isPinned -
Boolean
|
|
likeCount -
Int
|
|
recipientIds -
[String]
|
|
recipients -
[User]
|
|
startDate -
Date
|
|
title -
String
|
|
updatedAt -
Date
|
|
updatedUser -
User
|
|
visibility -
String
|
|
where -
String
|
Example
{
"_id": "abc123",
"attachments": {},
"ceremonyData": ExmCeremonyData,
"commentCount": 123,
"contentType": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "xyz789",
"endDate": "2007-12-03",
"eventData": ExmEventData,
"eventGoingUsers": [User],
"eventInterestedUsers": [User],
"heartCount": 987,
"images": {},
"isHearted": false,
"isLiked": false,
"isPinned": false,
"likeCount": 987,
"recipientIds": ["xyz789"],
"recipients": [User],
"startDate": "2007-12-03",
"title": "xyz789",
"updatedAt": "2007-12-03",
"updatedUser": User,
"visibility": "abc123",
"where": "xyz789"
}
ExmFeedResponse
ExmGoingOrInterested
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"going"
ExmList
ExmThank
Example
{
"_id": "abc123",
"createdAt": "2007-12-03",
"createdUser": User,
"description": "xyz789",
"recipientIds": ["xyz789"],
"recipients": [User],
"updatedAt": "2007-12-03"
}
ExmThankResponse
Fields
| Field Name | Description |
|---|---|
list -
[ExmThank]
|
|
totalCount -
Int
|
Example
{"list": [ExmThank], "totalCount": 987}
ExmWelcomeContent
ExmWelcomeContentInput
Fields
| Input Field | Description |
|---|---|
_id -
String
|
|
content -
String
|
|
image -
AttachmentInput
|
|
title -
String
|
Example
{
"_id": "abc123",
"content": "abc123",
"image": AttachmentInput,
"title": "abc123"
}
FacebookComment
Fields
| Field Name | Description |
|---|---|
attachments -
[String]
|
|
commentCount -
Int
|
|
commentId -
String
|
|
content -
String
|
|
conversationId -
String
|
|
customer -
Customer
|
|
erxesApiId -
String
|
|
isResolved -
Boolean
|
|
parentId -
String
|
|
permalink_url -
String
|
|
postId -
String
|
|
recipientId -
String
|
|
senderId -
String
|
|
timestamp -
Date
|
Example
{
"attachments": ["abc123"],
"commentCount": 123,
"commentId": "xyz789",
"content": "abc123",
"conversationId": "abc123",
"customer": Customer,
"erxesApiId": "abc123",
"isResolved": true,
"parentId": "abc123",
"permalink_url": "abc123",
"postId": "abc123",
"recipientId": "abc123",
"senderId": "xyz789",
"timestamp": "2007-12-03"
}
FacebookPost
Example
{
"attachments": ["xyz789"],
"content": "abc123",
"erxesApiId": "abc123",
"permalink_url": "abc123",
"postId": "xyz789",
"recipientId": "xyz789",
"senderId": "xyz789",
"timestamp": "2007-12-03"
}
Field
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
associatedField -
Field
|
|
associatedFieldId -
String
|
|
canHide -
Boolean
|
|
code -
String
|
|
column -
Int
|
|
content -
String
|
|
contentType -
String!
|
|
contentTypeId -
String
|
|
description -
String
|
|
groupId -
String
|
|
groupName -
String
|
|
isDefinedByErxes -
Boolean
|
|
isRequired -
Boolean
|
|
isVisible -
Boolean
|
|
isVisibleInDetail -
Boolean
|
|
lastUpdatedUser -
User
|
|
lastUpdatedUserId -
String
|
|
locationOptions -
[LocationOption]
|
|
logicAction -
String
|
|
logics -
[Logic]
|
|
name -
String
|
|
objectListConfigs -
[ObjectListConfig]
|
|
options -
[String]
|
|
order -
Int
|
|
pageNumber -
Int
|
|
productCategoryId -
String
|
|
products -
[Product]
|
|
searchable -
Boolean
|
|
showInCard -
Boolean
|
|
text -
String
|
|
type -
String
|
|
validation -
String
|
Example
{
"_id": "abc123",
"associatedField": Field,
"associatedFieldId": "abc123",
"canHide": false,
"code": "xyz789",
"column": 987,
"content": "abc123",
"contentType": "abc123",
"contentTypeId": "xyz789",
"description": "xyz789",
"groupId": "abc123",
"groupName": "abc123",
"isDefinedByErxes": true,
"isRequired": true,
"isVisible": true,
"isVisibleInDetail": false,
"lastUpdatedUser": User,
"lastUpdatedUserId": "xyz789",
"locationOptions": [LocationOption],
"logicAction": "abc123",
"logics": [Logic],
"name": "xyz789",
"objectListConfigs": [ObjectListConfig],
"options": ["abc123"],
"order": 123,
"pageNumber": 123,
"productCategoryId": "xyz789",
"products": [Product],
"searchable": true,
"showInCard": true,
"text": "abc123",
"type": "abc123",
"validation": "xyz789"
}
FieldItem
Fields
| Input Field | Description |
|---|---|
_id -
String
|
|
associatedFieldId -
String
|
|
code -
String
|
|
column -
Int
|
|
content -
String
|
|
description -
String
|
|
groupName -
String
|
|
isRequired -
Boolean
|
|
locationOptions -
[LocationOptionInput]
|
|
logicAction -
String
|
|
logics -
[LogicInput]
|
|
objectListConfigs -
[objectListConfigInput]
|
|
options -
[String]
|
|
order -
Int
|
|
pageNumber -
Int
|
|
productCategoryId -
String
|
|
searchable -
Boolean
|
|
showInCard -
Boolean
|
|
tempFieldId -
String
|
|
text -
String
|
|
type -
String
|
|
validation -
String
|
Example
{
"_id": "abc123",
"associatedFieldId": "xyz789",
"code": "xyz789",
"column": 123,
"content": "abc123",
"description": "xyz789",
"groupName": "abc123",
"isRequired": false,
"locationOptions": [LocationOptionInput],
"logicAction": "abc123",
"logics": [LogicInput],
"objectListConfigs": [objectListConfigInput],
"options": ["abc123"],
"order": 123,
"pageNumber": 987,
"productCategoryId": "abc123",
"searchable": true,
"showInCard": false,
"tempFieldId": "abc123",
"text": "abc123",
"type": "abc123",
"validation": "abc123"
}
FieldValueInput
Example
{
"_id": "abc123",
"associatedFieldId": "abc123",
"column": 123,
"groupId": "xyz789",
"productId": "abc123",
"stageId": "abc123",
"text": "abc123",
"type": "abc123",
"validation": "abc123",
"value": {}
}
FieldsGroup
Example
{
"_id": "abc123",
"code": "xyz789",
"config": {},
"contentType": "xyz789",
"description": "abc123",
"fields": [Field],
"isDefinedByErxes": false,
"isVisible": false,
"isVisibleInDetail": true,
"lastUpdatedUser": User,
"lastUpdatedUserId": "abc123",
"name": "abc123",
"order": 123
}
FilterType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"today"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
987.65
Form
Example
{
"_id": "abc123",
"buttonText": "xyz789",
"code": "xyz789",
"createdDate": "2007-12-03",
"createdUser": User,
"createdUserId": "xyz789",
"description": "abc123",
"fields": [Field],
"googleMapApiKey": "abc123",
"numberOfPages": 123,
"title": "xyz789",
"type": "xyz789"
}
FormConnectResponse
Fields
| Field Name | Description |
|---|---|
form -
Form
|
|
integration -
Integration
|
Example
{
"form": Form,
"integration": Integration
}
FormSubmission
Example
{
"_id": "xyz789",
"customerId": "abc123",
"formFieldId": "xyz789",
"formFieldText": "abc123",
"formId": "abc123",
"submittedAt": "2007-12-03",
"text": "abc123",
"value": {}
}
GrowthHack
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
assignedUserIds -
[String]
|
|
assignedUsers -
[User]
|
|
attachments -
[Attachment]
|
|
boardId -
String
|
|
closeDate -
Date
|
|
confidence -
Int
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
ease -
Int
|
|
formFields -
[Field]
|
|
formId -
String
|
|
formSubmissions -
JSON
|
|
hackStages -
[String]
|
|
hasNotified -
Boolean
|
|
impact -
Int
|
|
isComplete -
Boolean
|
|
isVoted -
Boolean
|
|
isWatched -
Boolean
|
|
labelIds -
[String]
|
|
labels -
[PipelineLabel]
|
|
modifiedAt -
Date
|
|
modifiedBy -
String
|
|
name -
String!
|
|
number -
String
|
|
order -
Float
|
|
pipeline -
Pipeline
|
|
priority -
String
|
|
reach -
Int
|
|
reminderMinute -
Int
|
|
score -
Float
|
|
scoringType -
String
|
|
stage -
Stage
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
|
timeTrack -
TimeTrack
|
|
userId -
String
|
|
voteCount -
Int
|
|
votedUsers -
[User]
|
Example
{
"_id": "xyz789",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"confidence": 987,
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"description": "abc123",
"ease": 987,
"formFields": [Field],
"formId": "abc123",
"formSubmissions": {},
"hackStages": ["abc123"],
"hasNotified": true,
"impact": 123,
"isComplete": true,
"isVoted": true,
"isWatched": false,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "xyz789",
"name": "abc123",
"number": "xyz789",
"order": 987.65,
"pipeline": Pipeline,
"priority": "abc123",
"reach": 123,
"reminderMinute": 123,
"score": 987.65,
"scoringType": "xyz789",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123",
"voteCount": 123,
"votedUsers": [User]
}
ImportHistory
Example
{
"_id": "abc123",
"attachments": {},
"contentTypes": {},
"date": "2007-12-03",
"error": "xyz789",
"errorMsgs": ["abc123"],
"failed": "xyz789",
"ids": ["abc123"],
"name": "abc123",
"percentage": 123.45,
"removed": ["abc123"],
"status": "xyz789",
"success": "xyz789",
"total": "xyz789",
"updated": "abc123",
"user": {}
}
ImportHistoryList
Fields
| Field Name | Description |
|---|---|
count -
Int
|
|
list -
[ImportHistory]
|
Example
{"count": 987, "list": [ImportHistory]}
InboxField
InputRule
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
Integration
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
bookingData -
BookingData
|
|
brand -
Brand
|
|
brandId -
String!
|
|
channels -
[Channel]
|
|
code -
String
|
|
departmentIds -
[String]
|
|
form -
Form
|
|
formId -
String
|
|
healthStatus -
JSON
|
|
isActive -
Boolean
|
|
kind -
String!
|
|
knowledgeBaseMessengerApps -
[MessengerApp]
|
|
languageCode -
String
|
|
leadData -
JSON
|
|
leadMessengerApps -
[MessengerApp]
|
|
messengerData -
JSON
|
|
name -
String!
|
|
tagIds -
[String]
|
|
tags -
[Tag]
|
|
uiOptions -
JSON
|
|
visibility -
String
|
|
webhookData -
JSON
|
|
websiteMessengerApps -
[MessengerApp]
|
Example
{
"_id": "abc123",
"bookingData": BookingData,
"brand": Brand,
"brandId": "xyz789",
"channels": [Channel],
"code": "abc123",
"departmentIds": ["abc123"],
"form": Form,
"formId": "xyz789",
"healthStatus": {},
"isActive": false,
"kind": "abc123",
"knowledgeBaseMessengerApps": [MessengerApp],
"languageCode": "abc123",
"leadData": {},
"leadMessengerApps": [MessengerApp],
"messengerData": {},
"name": "xyz789",
"tagIds": ["abc123"],
"tags": [Tag],
"uiOptions": {},
"visibility": "abc123",
"webhookData": {},
"websiteMessengerApps": [MessengerApp]
}
IntegrationBookingData
Fields
| Input Field | Description |
|---|---|
bookingFormText -
String
|
|
description -
String
|
|
image -
AttachmentInput
|
|
name -
String
|
|
navigationText -
String
|
|
productCategoryId -
String
|
|
productFieldIds -
[String]
|
|
style -
BookingStyleInput
|
Example
{
"bookingFormText": "xyz789",
"description": "xyz789",
"image": AttachmentInput,
"name": "abc123",
"navigationText": "abc123",
"productCategoryId": "xyz789",
"productFieldIds": ["xyz789"],
"style": BookingStyleInput
}
IntegrationLeadData
Fields
| Input Field | Description |
|---|---|
adminEmailContent -
String
|
|
adminEmailTitle -
String
|
|
adminEmails -
[String]
|
|
attachments -
[AttachmentInput]
|
|
callout -
JSON
|
|
css -
String
|
|
fromEmail -
String
|
|
isRequireOnce -
Boolean
|
|
loadType -
String
|
|
redirectUrl -
String
|
|
rules -
[InputRule]
|
|
saveAsCustomer -
Boolean
|
|
successAction -
String
|
|
successImage -
String
|
|
successImageSize -
String
|
|
templateId -
String
|
|
thankContent -
String
|
|
thankTitle -
String
|
|
themeColor -
String
|
|
userEmailContent -
String
|
|
userEmailTitle -
String
|
Example
{
"adminEmailContent": "xyz789",
"adminEmailTitle": "abc123",
"adminEmails": ["abc123"],
"attachments": [AttachmentInput],
"callout": {},
"css": "abc123",
"fromEmail": "abc123",
"isRequireOnce": false,
"loadType": "xyz789",
"redirectUrl": "xyz789",
"rules": [InputRule],
"saveAsCustomer": true,
"successAction": "xyz789",
"successImage": "abc123",
"successImageSize": "abc123",
"templateId": "xyz789",
"thankContent": "xyz789",
"thankTitle": "abc123",
"themeColor": "abc123",
"userEmailContent": "abc123",
"userEmailTitle": "xyz789"
}
IntegrationLinks
IntegrationMessengerData
Fields
| Input Field | Description |
|---|---|
_id -
String
|
|
availabilityMethod -
String
|
|
botEndpointUrl -
String
|
|
botShowInitialMessage -
Boolean
|
|
forceLogoutWhenResolve -
Boolean
|
|
isOnline -
Boolean
|
|
knowledgeBaseTopicId -
String
|
|
links -
IntegrationLinks
|
|
messages -
JSON
|
|
notifyCustomer -
Boolean
|
|
onlineHours -
[MessengerOnlineHoursSchema]
|
|
requireAuth -
Boolean
|
|
responseRate -
String
|
|
showChat -
Boolean
|
|
showLauncher -
Boolean
|
|
showTimezone -
Boolean
|
|
showVideoCallRequest -
Boolean
|
|
skillData -
JSON
|
|
supporterIds -
[String]
|
|
timezone -
String
|
Example
{
"_id": "xyz789",
"availabilityMethod": "abc123",
"botEndpointUrl": "xyz789",
"botShowInitialMessage": false,
"forceLogoutWhenResolve": true,
"isOnline": false,
"knowledgeBaseTopicId": "abc123",
"links": IntegrationLinks,
"messages": {},
"notifyCustomer": true,
"onlineHours": [MessengerOnlineHoursSchema],
"requireAuth": false,
"responseRate": "abc123",
"showChat": false,
"showLauncher": false,
"showTimezone": true,
"showVideoCallRequest": true,
"skillData": {},
"supporterIds": ["xyz789"],
"timezone": "xyz789"
}
InternalNote
Example
{
"_id": "xyz789",
"content": "abc123",
"contentType": "abc123",
"contentTypeId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"createdUserId": "xyz789"
}
InternalNotesByAction
Fields
| Field Name | Description |
|---|---|
list -
[ModifiedNote]
|
|
totalCount -
Int
|
Example
{"list": [ModifiedNote], "totalCount": 123}
InvitationEntry
Example
{
"branchId": "xyz789",
"channelIds": ["xyz789"],
"departmentId": "abc123",
"email": "abc123",
"groupId": "abc123",
"password": "abc123",
"unitId": "abc123"
}
ItemDate
JSON
Description
The jSON scalar type represents jSON values as specified by
ECMA-404.
Example
{}
KhorooInput
Fields
| Input Field | Description |
|---|---|
address -
String
|
|
ageGroup -
ageGroupsInput
|
|
aptHouseholder -
Float
|
|
distance -
String
|
|
hospital -
String
|
|
khorooNumber -
String
|
|
locationValue -
LocationInput
|
|
phoneNumber -
String
|
|
sex -
sexInput
|
Example
{
"address": "xyz789",
"ageGroup": ageGroupsInput,
"aptHouseholder": 123.45,
"distance": "xyz789",
"hospital": "xyz789",
"khorooNumber": "abc123",
"locationValue": LocationInput,
"phoneNumber": "abc123",
"sex": sexInput
}
KnowledgeBaseArticle
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
attachments -
[Attachment]
|
|
categoryId -
String
|
|
content -
String
|
|
createdBy -
String
|
|
createdDate -
Date
|
|
createdUser -
User
|
|
image -
Attachment
|
|
modifiedBy -
String
|
|
modifiedDate -
Date
|
|
reactionChoices -
[String]
|
|
reactionCounts -
JSON
|
|
status -
String
|
|
summary -
String
|
|
title -
String
|
|
topicId -
String
|
|
viewCount -
Int
|
Example
{
"_id": "xyz789",
"attachments": [Attachment],
"categoryId": "abc123",
"content": "abc123",
"createdBy": "abc123",
"createdDate": "2007-12-03",
"createdUser": User,
"image": Attachment,
"modifiedBy": "abc123",
"modifiedDate": "2007-12-03",
"reactionChoices": ["xyz789"],
"reactionCounts": {},
"status": "xyz789",
"summary": "xyz789",
"title": "abc123",
"topicId": "abc123",
"viewCount": 987
}
KnowledgeBaseArticleDoc
Fields
| Input Field | Description |
|---|---|
attachments -
[AttachmentInput]
|
|
categoryId -
String
|
|
categoryIds -
[String]
|
|
content -
String!
|
|
image -
AttachmentInput
|
|
reactionChoices -
[String]
|
|
status -
String!
|
|
summary -
String
|
|
title -
String!
|
|
topicId -
String
|
Example
{
"attachments": [AttachmentInput],
"categoryId": "abc123",
"categoryIds": ["xyz789"],
"content": "abc123",
"image": AttachmentInput,
"reactionChoices": ["xyz789"],
"status": "xyz789",
"summary": "xyz789",
"title": "abc123",
"topicId": "xyz789"
}
KnowledgeBaseCategory
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
articles -
[KnowledgeBaseArticle]
|
|
authors -
[User]
|
|
createdBy -
String
|
|
createdDate -
Date
|
|
description -
String
|
|
firstTopic -
KnowledgeBaseTopic
|
|
icon -
String
|
|
modifiedBy -
String
|
|
modifiedDate -
Date
|
|
numOfArticles -
Float
|
|
parentCategoryId -
String
|
|
title -
String
|
Example
{
"_id": "abc123",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "abc123",
"firstTopic": KnowledgeBaseTopic,
"icon": "abc123",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"numOfArticles": 987.65,
"parentCategoryId": "abc123",
"title": "xyz789"
}
KnowledgeBaseCategoryDoc
Example
{
"articleIds": ["abc123"],
"description": "xyz789",
"icon": "xyz789",
"parentCategoryId": "abc123",
"title": "abc123",
"topicId": "xyz789",
"topicIds": ["xyz789"]
}
KnowledgeBaseMessengerAppInput
Fields
| Input Field | Description |
|---|---|
topicId -
String
|
Example
{"topicId": "xyz789"}
KnowledgeBaseParentCategory
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
articles -
[KnowledgeBaseArticle]
|
|
authors -
[User]
|
|
childrens -
[KnowledgeBaseCategory]
|
|
createdBy -
String
|
|
createdDate -
Date
|
|
description -
String
|
|
firstTopic -
KnowledgeBaseTopic
|
|
icon -
String
|
|
modifiedBy -
String
|
|
modifiedDate -
Date
|
|
numOfArticles -
Float
|
|
parentCategoryId -
String
|
|
title -
String
|
Example
{
"_id": "abc123",
"articles": [KnowledgeBaseArticle],
"authors": [User],
"childrens": [KnowledgeBaseCategory],
"createdBy": "abc123",
"createdDate": "2007-12-03",
"description": "abc123",
"firstTopic": KnowledgeBaseTopic,
"icon": "abc123",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"numOfArticles": 987.65,
"parentCategoryId": "abc123",
"title": "abc123"
}
KnowledgeBaseTopic
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
backgroundImage -
String
|
|
brand -
Brand
|
|
categories -
[KnowledgeBaseCategory]
|
|
color -
String
|
|
createdBy -
String
|
|
createdDate -
Date
|
|
description -
String
|
|
languageCode -
String
|
|
modifiedBy -
String
|
|
modifiedDate -
Date
|
|
parentCategories -
[KnowledgeBaseParentCategory]
|
|
title -
String
|
Example
{
"_id": "abc123",
"backgroundImage": "abc123",
"brand": Brand,
"categories": [KnowledgeBaseCategory],
"color": "abc123",
"createdBy": "xyz789",
"createdDate": "2007-12-03",
"description": "xyz789",
"languageCode": "xyz789",
"modifiedBy": "xyz789",
"modifiedDate": "2007-12-03",
"parentCategories": [KnowledgeBaseParentCategory],
"title": "abc123"
}
KnowledgeBaseTopicDoc
Example
{
"backgroundImage": "xyz789",
"brandId": "xyz789",
"categoryIds": ["xyz789"],
"color": "xyz789",
"description": "abc123",
"languageCode": "xyz789",
"title": "xyz789"
}
KnowledgebaseApp
Fields
| Field Name | Description |
|---|---|
topicId -
String
|
Example
{"topicId": "abc123"}
LeadApp
Fields
| Field Name | Description |
|---|---|
formCode -
String
|
Example
{"formCode": "xyz789"}
LeadMessengerAppInput
Fields
| Input Field | Description |
|---|---|
formCode -
String
|
Example
{"formCode": "abc123"}
LocationInput
LocationOption
LocationOptionInput
Log
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
action -
String
|
|
addedData -
String
|
|
changedData -
String
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
description -
String
|
|
extraDesc -
String
|
|
newData -
String
|
|
objectId -
String
|
|
oldData -
String
|
|
removedData -
String
|
|
type -
String
|
|
unchangedData -
String
|
|
unicode -
String
|
Example
{
"_id": "abc123",
"action": "xyz789",
"addedData": "abc123",
"changedData": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"extraDesc": "xyz789",
"newData": "xyz789",
"objectId": "abc123",
"oldData": "xyz789",
"removedData": "abc123",
"type": "abc123",
"unchangedData": "xyz789",
"unicode": "abc123"
}
LogList
Logic
LogicInput
Lottery
Example
{
"_id": "xyz789",
"awardId": "abc123",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"number": "xyz789",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789",
"status": "xyz789",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123",
"voucherId": "abc123"
}
LotteryCampaign
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
attachment -
Attachment
|
|
awards -
JSON
|
|
buyScore -
Float
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
description -
String
|
|
endDate -
Date
|
|
finishDateOfUse -
Date
|
|
lotteriesCount -
Int
|
|
modifiedAt -
Date
|
|
modifiedBy -
String
|
|
numberFormat -
String
|
|
startDate -
Date
|
|
status -
String
|
|
title -
String
|
Example
{
"_id": "xyz789",
"attachment": Attachment,
"awards": {},
"buyScore": 123.45,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "abc123",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteriesCount": 987,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"numberFormat": "abc123",
"startDate": "2007-12-03",
"status": "abc123",
"title": "xyz789"
}
LotteryMain
Loyalty
Example
{
"donates": [Donate],
"lotteries": [Lottery],
"ownerId": "xyz789",
"ownerType": "abc123",
"score": 123.45,
"spins": [Spin],
"vouchers": [Voucher]
}
LoyaltyConfig
MailAttachment
Example
{
"attachmentId": "xyz789",
"content_type": "abc123",
"data": "abc123",
"filename": "abc123",
"id": "xyz789",
"mimeType": "xyz789",
"size": 987
}
MailData
Fields
| Field Name | Description |
|---|---|
accountId -
String
|
|
attachments -
[MailAttachment]
|
|
bcc -
[Email]
|
|
body -
String
|
|
cc -
[Email]
|
|
from -
[Email]
|
|
headerId -
String
|
|
inReplyTo -
String
|
|
integrationEmail -
String
|
|
messageId -
String
|
|
references -
[String]
|
|
replyTo -
[String]
|
|
replyToMessageId -
[String]
|
|
subject -
String
|
|
threadId -
String
|
|
to -
[Email]
|
Example
{
"accountId": "abc123",
"attachments": [MailAttachment],
"bcc": [Email],
"body": "abc123",
"cc": [Email],
"from": [Email],
"headerId": "abc123",
"inReplyTo": "xyz789",
"integrationEmail": "xyz789",
"messageId": "xyz789",
"references": ["xyz789"],
"replyTo": ["xyz789"],
"replyToMessageId": ["abc123"],
"subject": "xyz789",
"threadId": "xyz789",
"to": [Email]
}
MessengerApp
MessengerAppsInput
Fields
| Input Field | Description |
|---|---|
knowledgebases -
[KnowledgeBaseMessengerAppInput]
|
|
leads -
[LeadMessengerAppInput]
|
|
websites -
[WebSiteMessengerAppInput]
|
Example
{
"knowledgebases": [KnowledgeBaseMessengerAppInput],
"leads": [LeadMessengerAppInput],
"websites": [WebSiteMessengerAppInput]
}
MessengerAppsResponse
Fields
| Field Name | Description |
|---|---|
knowledgebases -
[KnowledgebaseApp]
|
|
leads -
[LeadApp]
|
|
websites -
[WebSiteApp]
|
Example
{
"knowledgebases": [KnowledgebaseApp],
"leads": [LeadApp],
"websites": [WebSiteApp]
}
MessengerConnectResponse
Example
{
"brand": Brand,
"customerId": "xyz789",
"integrationId": "abc123",
"languageCode": "abc123",
"messengerData": {},
"uiOptions": {},
"visitorId": "abc123"
}
MessengerOnlineHoursSchema
MessengerSupportersResponse
MessengerUiOptions
ModifiedNote
Example
{
"_id": "xyz789",
"action": "abc123",
"content": "xyz789",
"contentId": "xyz789",
"contentType": "abc123",
"contentTypeDetail": {},
"createdAt": "2007-12-03",
"createdBy": "abc123"
}
Neighbor
Notification
Example
{
"_id": "abc123",
"action": "abc123",
"content": "xyz789",
"createdUser": User,
"date": "2007-12-03",
"isRead": false,
"link": "abc123",
"notifType": "abc123",
"receiver": "xyz789",
"title": "abc123"
}
NotificationConfiguration
OTPConfig
OTPConfigInput
ObjectListConfig
OnboardingGetAvailableFeaturesResponse
OnboardingHistory
OrderItem
Permission
Example
{
"_id": "abc123",
"action": "xyz789",
"allowed": false,
"group": UsersGroup,
"groupId": "abc123",
"module": "abc123",
"requiredActions": ["abc123"],
"user": User,
"userId": "abc123"
}
PermissionAction
PermissionModule
Pipeline
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
bgColor -
String
|
|
boardId -
String!
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
departmentIds -
[String]
|
|
endDate -
Date
|
|
excludeCheckUserIds -
[String]
|
|
hackScoringType -
String
|
|
isCheckDepartment -
Boolean
|
|
isCheckUser -
Boolean
|
|
isWatched -
Boolean
|
|
itemsTotalCount -
Int
|
|
memberIds -
[String]
|
|
members -
[User]
|
|
metric -
String
|
|
name -
String!
|
|
numberConfig -
String
|
|
numberSize -
String
|
|
order -
Int
|
|
startDate -
Date
|
|
state -
String
|
|
status -
String
|
|
templateId -
String
|
|
type -
String
|
|
userId -
String
|
|
visibility -
String!
|
Example
{
"_id": "xyz789",
"bgColor": "xyz789",
"boardId": "xyz789",
"createdAt": "2007-12-03",
"createdUser": User,
"departmentIds": ["xyz789"],
"endDate": "2007-12-03",
"excludeCheckUserIds": ["abc123"],
"hackScoringType": "xyz789",
"isCheckDepartment": false,
"isCheckUser": false,
"isWatched": false,
"itemsTotalCount": 987,
"memberIds": ["xyz789"],
"members": [User],
"metric": "abc123",
"name": "xyz789",
"numberConfig": "abc123",
"numberSize": "xyz789",
"order": 123,
"startDate": "2007-12-03",
"state": "xyz789",
"status": "xyz789",
"templateId": "xyz789",
"type": "abc123",
"userId": "abc123",
"visibility": "abc123"
}
PipelineLabel
PipelineTemplate
Example
{
"_id": "abc123",
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"isDefinedByErxes": false,
"name": "xyz789",
"stages": [PipelineTemplateStage],
"type": "abc123"
}
PipelineTemplateStage
PipelineTemplateStageInput
Product
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
attachment -
Attachment
|
|
attachmentMore -
[Attachment]
|
|
category -
ProductCategory
|
|
categoryId -
String
|
|
code -
String
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
description -
String
|
|
getTags -
[Tag]
|
|
minimiumCount -
Int
|
|
name -
String
|
|
productCount -
Int
|
|
sku -
String
|
|
supply -
String
|
|
tagIds -
[String]
|
|
type -
String
|
|
unitPrice -
Float
|
|
vendor -
Company
|
|
vendorId -
String
|
Example
{
"_id": "abc123",
"attachment": Attachment,
"attachmentMore": [Attachment],
"category": ProductCategory,
"categoryId": "xyz789",
"code": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"description": "abc123",
"getTags": [Tag],
"minimiumCount": 123,
"name": "xyz789",
"productCount": 123,
"sku": "xyz789",
"supply": "xyz789",
"tagIds": ["xyz789"],
"type": "xyz789",
"unitPrice": 123.45,
"vendor": Company,
"vendorId": "abc123"
}
ProductCategory
Example
{
"_id": "abc123",
"attachment": Attachment,
"code": "xyz789",
"description": "xyz789",
"isRoot": true,
"name": "xyz789",
"order": "xyz789",
"parentId": "xyz789",
"productCount": 123,
"status": "xyz789"
}
ReactionContentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"exmFeed"
RecipientType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"recieved"
ResponseTemplate
RobotEntry
SaveFormResponse
Example
{
"customerId": "abc123",
"errors": [Error],
"invoiceResponse": "abc123",
"invoiceType": "abc123",
"messageId": "abc123",
"status": "abc123",
"userId": "xyz789"
}
SchemaField
SchoolInput
Fields
| Input Field | Description |
|---|---|
description -
String
|
|
district -
String
|
|
khoroo -
String
|
|
locationValue -
LocationInput
|
Example
{
"description": "xyz789",
"district": "abc123",
"khoroo": "abc123",
"locationValue": LocationInput
}
ScoreLog
Example
{
"changeScore": 123.45,
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"owner": {},
"ownerId": "xyz789",
"ownerType": "xyz789"
}
Script
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
kbTopic -
KnowledgeBaseTopic
|
|
kbTopicId -
String
|
|
leadIds -
[String]
|
|
leads -
[Integration]
|
|
messenger -
Integration
|
|
messengerId -
String
|
|
name -
String!
|
Example
{
"_id": "xyz789",
"kbTopic": KnowledgeBaseTopic,
"kbTopicId": "xyz789",
"leadIds": ["xyz789"],
"leads": [Integration],
"messenger": Integration,
"messengerId": "xyz789",
"name": "xyz789"
}
SeenInfo
Segment
Example
{
"_id": "xyz789",
"color": "abc123",
"conditions": {},
"conditionsConjunction": "abc123",
"config": {},
"contentType": "xyz789",
"count": 123,
"description": "abc123",
"getSubSegments": [Segment],
"name": "xyz789",
"shouldWriteActivityLog": false,
"subOf": "xyz789",
"subSegmentConditions": [Segment]
}
SegmentCondition
Example
{
"config": {},
"eventAttributeFilters": [EventAttributeFilter],
"eventName": "abc123",
"eventOccurence": "xyz789",
"eventOccurenceValue": 123.45,
"propertyName": "xyz789",
"propertyOperator": "abc123",
"propertyType": "xyz789",
"propertyValue": "abc123",
"subSegmentId": "abc123",
"type": "xyz789"
}
Skill
SkillType
SmsDelivery
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
content -
String
|
|
conversationId -
String
|
|
createdAt -
Date
|
|
direction -
String
|
|
engageMessageId -
String
|
|
errorMessages -
[String]
|
|
erxesApiId -
String
|
|
from -
String
|
|
integrationId -
String
|
|
requestData -
String
|
|
responseData -
String
|
|
status -
String
|
|
statusUpdates -
[SmsStatus]
|
|
telnyxId -
String
|
|
to -
String
|
Example
{
"_id": "xyz789",
"content": "xyz789",
"conversationId": "abc123",
"createdAt": "2007-12-03",
"direction": "xyz789",
"engageMessageId": "xyz789",
"errorMessages": ["xyz789"],
"erxesApiId": "abc123",
"from": "xyz789",
"integrationId": "abc123",
"requestData": "abc123",
"responseData": "xyz789",
"status": "abc123",
"statusUpdates": [SmsStatus],
"telnyxId": "abc123",
"to": "abc123"
}
SmsStatus
SohInput
SourceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"admin"
Spin
Example
{
"_id": "xyz789",
"awardId": "xyz789",
"campaign": {},
"campaignId": "xyz789",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "xyz789",
"voucherId": "xyz789"
}
SpinCampaign
Example
{
"_id": "abc123",
"attachment": Attachment,
"awards": {},
"buyScore": 123.45,
"createdAt": "2007-12-03",
"createdBy": "abc123",
"description": "xyz789",
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"spinsCount": 123,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "xyz789"
}
SpinMain
Stage
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
age -
Int
|
|
amount -
JSON
|
|
code -
String
|
|
compareNextStage -
JSON
|
|
createdAt -
Date
|
|
departmentIds -
[String]
|
|
formId -
String
|
|
inProcessDealsTotalCount -
Int
|
|
initialDealsTotalCount -
Int
|
|
itemsTotalCount -
Int
|
|
memberIds -
[String]
|
|
members -
[User]
|
|
name -
String!
|
|
order -
Int
|
|
pipelineId -
String!
|
|
probability -
String
|
|
status -
String
|
|
stayedDealsTotalCount -
Int
|
|
type -
String
|
|
visibility -
String
|
Example
{
"_id": "xyz789",
"age": 987,
"amount": {},
"code": "abc123",
"compareNextStage": {},
"createdAt": "2007-12-03",
"departmentIds": ["xyz789"],
"formId": "xyz789",
"inProcessDealsTotalCount": 123,
"initialDealsTotalCount": 123,
"itemsTotalCount": 123,
"memberIds": ["xyz789"],
"members": [User],
"name": "abc123",
"order": 987,
"pipelineId": "abc123",
"probability": "xyz789",
"status": "abc123",
"stayedDealsTotalCount": 123,
"type": "xyz789",
"visibility": "abc123"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Structure
Example
{
"_id": "abc123",
"code": "xyz789",
"coordinate": Coordinate,
"description": "abc123",
"email": "abc123",
"image": Attachment,
"links": {},
"phoneNumber": "xyz789",
"supervisor": User,
"supervisorId": "abc123",
"title": "abc123"
}
Styles
Fields
| Field Name | Description |
|---|---|
activeTabColor -
String
|
|
backgroundColor -
String
|
|
baseColor -
String
|
|
baseFont -
String
|
|
bodyColor -
String
|
|
dividerColor -
String
|
|
footerColor -
String
|
|
headerColor -
String
|
|
headingColor -
String
|
|
headingFont -
String
|
|
helpColor -
String
|
|
linkColor -
String
|
|
linkHoverColor -
String
|
|
primaryBtnColor -
String
|
|
secondaryBtnColor -
String
|
Example
{
"activeTabColor": "xyz789",
"backgroundColor": "abc123",
"baseColor": "xyz789",
"baseFont": "xyz789",
"bodyColor": "xyz789",
"dividerColor": "abc123",
"footerColor": "xyz789",
"headerColor": "abc123",
"headingColor": "xyz789",
"headingFont": "abc123",
"helpColor": "abc123",
"linkColor": "abc123",
"linkHoverColor": "xyz789",
"primaryBtnColor": "xyz789",
"secondaryBtnColor": "abc123"
}
StylesParams
Fields
| Input Field | Description |
|---|---|
activeTabColor -
String
|
|
backgroundColor -
String
|
|
baseColor -
String
|
|
baseFont -
String
|
|
bodyColor -
String
|
|
dividerColor -
String
|
|
footerColor -
String
|
|
headerColor -
String
|
|
headingColor -
String
|
|
headingFont -
String
|
|
helpColor -
String
|
|
linkColor -
String
|
|
linkHoverColor -
String
|
|
primaryBtnColor -
String
|
|
secondaryBtnColor -
String
|
Example
{
"activeTabColor": "abc123",
"backgroundColor": "abc123",
"baseColor": "abc123",
"baseFont": "xyz789",
"bodyColor": "xyz789",
"dividerColor": "xyz789",
"footerColor": "abc123",
"headerColor": "xyz789",
"headingColor": "xyz789",
"headingFont": "xyz789",
"helpColor": "xyz789",
"linkColor": "abc123",
"linkHoverColor": "abc123",
"primaryBtnColor": "xyz789",
"secondaryBtnColor": "xyz789"
}
SubSegment
Submission
Example
{
"_id": "xyz789",
"contentTypeId": "abc123",
"createdAt": "2007-12-03",
"customFieldsData": {},
"customer": Customer,
"customerId": "abc123",
"submissions": [FormSubmission]
}
SubmissionFilter
SuccessResult
Fields
| Field Name | Description |
|---|---|
success -
Boolean
|
Example
{"success": true}
Tag
Example
{
"_id": "xyz789",
"colorCode": "xyz789",
"createdAt": "2007-12-03",
"name": "abc123",
"objectCount": 123,
"order": "abc123",
"parentId": "abc123",
"relatedIds": ["xyz789"],
"totalObjectCount": 123,
"type": "abc123"
}
Task
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
assignedUserIds -
[String]
|
|
assignedUsers -
[User]
|
|
attachments -
[Attachment]
|
|
boardId -
String
|
|
closeDate -
Date
|
|
companies -
[Company]
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
customFieldsData -
JSON
|
|
customers -
[Customer]
|
|
description -
String
|
|
hasNotified -
Boolean
|
|
isComplete -
Boolean
|
|
isWatched -
Boolean
|
|
labelIds -
[String]
|
|
labels -
[PipelineLabel]
|
|
modifiedAt -
Date
|
|
modifiedBy -
String
|
|
name -
String!
|
|
number -
String
|
|
order -
Float
|
|
pipeline -
Pipeline
|
|
priority -
String
|
|
reminderMinute -
Int
|
|
score -
Float
|
|
stage -
Stage
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
|
timeTrack -
TimeTrack
|
|
userId -
String
|
Example
{
"_id": "xyz789",
"assignedUserIds": ["xyz789"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "abc123",
"hasNotified": true,
"isComplete": false,
"isWatched": true,
"labelIds": ["xyz789"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 123.45,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 987,
"score": 987.65,
"stage": Stage,
"stageId": "xyz789",
"startDate": "2007-12-03",
"status": "abc123",
"timeTrack": TimeTrack,
"userId": "xyz789"
}
TaskListItem
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
assignedUsers -
JSON
|
|
closeDate -
Date
|
|
companies -
JSON
|
|
createdAt -
Date
|
|
customers -
JSON
|
|
hasNotified -
Boolean
|
|
isComplete -
Boolean
|
|
isWatched -
Boolean
|
|
labels -
JSON
|
|
modifiedAt -
Date
|
|
name -
String
|
|
number -
String
|
|
priority -
String
|
|
relations -
JSON
|
|
score -
Float
|
|
stage -
JSON
|
|
startDate -
Date
|
Example
{
"_id": "abc123",
"assignedUsers": {},
"closeDate": "2007-12-03",
"companies": {},
"createdAt": "2007-12-03",
"customers": {},
"hasNotified": true,
"isComplete": false,
"isWatched": true,
"labels": {},
"modifiedAt": "2007-12-03",
"name": "xyz789",
"number": "abc123",
"priority": "abc123",
"relations": {},
"score": 123.45,
"stage": {},
"startDate": "2007-12-03"
}
Ticket
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
assignedUserIds -
[String]
|
|
assignedUsers -
[User]
|
|
attachments -
[Attachment]
|
|
boardId -
String
|
|
closeDate -
Date
|
|
companies -
[Company]
|
|
createdAt -
Date
|
|
createdUser -
User
|
|
customFieldsData -
JSON
|
|
customers -
[Customer]
|
|
description -
String
|
|
hasNotified -
Boolean
|
|
isComplete -
Boolean
|
|
isWatched -
Boolean
|
|
labelIds -
[String]
|
|
labels -
[PipelineLabel]
|
|
modifiedAt -
Date
|
|
modifiedBy -
String
|
|
name -
String!
|
|
number -
String
|
|
order -
Float
|
|
pipeline -
Pipeline
|
|
priority -
String
|
|
reminderMinute -
Int
|
|
score -
Float
|
|
source -
String
|
|
stage -
Stage
|
|
stageId -
String
|
|
startDate -
Date
|
|
status -
String
|
|
timeTrack -
TimeTrack
|
|
userId -
String
|
Example
{
"_id": "abc123",
"assignedUserIds": ["abc123"],
"assignedUsers": [User],
"attachments": [Attachment],
"boardId": "xyz789",
"closeDate": "2007-12-03",
"companies": [Company],
"createdAt": "2007-12-03",
"createdUser": User,
"customFieldsData": {},
"customers": [Customer],
"description": "xyz789",
"hasNotified": true,
"isComplete": false,
"isWatched": false,
"labelIds": ["abc123"],
"labels": [PipelineLabel],
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"name": "xyz789",
"number": "xyz789",
"order": 123.45,
"pipeline": Pipeline,
"priority": "xyz789",
"reminderMinute": 123,
"score": 987.65,
"source": "xyz789",
"stage": Stage,
"stageId": "abc123",
"startDate": "2007-12-03",
"status": "xyz789",
"timeTrack": TimeTrack,
"userId": "abc123"
}
TicketListItem
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
assignedUsers -
JSON
|
|
closeDate -
Date
|
|
companies -
JSON
|
|
createdAt -
Date
|
|
customers -
JSON
|
|
hasNotified -
Boolean
|
|
isComplete -
Boolean
|
|
isWatched -
Boolean
|
|
labels -
JSON
|
|
modifiedAt -
Date
|
|
name -
String
|
|
number -
String
|
|
priority -
String
|
|
relations -
JSON
|
|
score -
Float
|
|
stage -
JSON
|
|
startDate -
Date
|
Example
{
"_id": "xyz789",
"assignedUsers": {},
"closeDate": "2007-12-03",
"companies": {},
"createdAt": "2007-12-03",
"customers": {},
"hasNotified": false,
"isComplete": false,
"isWatched": false,
"labels": {},
"modifiedAt": "2007-12-03",
"name": "xyz789",
"number": "xyz789",
"priority": "abc123",
"relations": {},
"score": 987.65,
"stage": {},
"startDate": "2007-12-03"
}
TimeTrack
TotalForType
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
currencies -
[DealTotalCurrency]
|
|
name -
String
|
Example
{
"_id": "abc123",
"currencies": [DealTotalCurrency],
"name": "xyz789"
}
Trigger
Example
{
"actionId": "abc123",
"config": {},
"count": 987,
"description": "abc123",
"icon": "xyz789",
"id": "xyz789",
"label": "xyz789",
"style": {},
"type": "abc123"
}
TriggerInput
Example
{
"actionId": "abc123",
"config": {},
"description": "abc123",
"icon": "xyz789",
"id": "xyz789",
"label": "xyz789",
"style": {},
"type": "abc123"
}
Unit
Example
{
"_id": "xyz789",
"code": "abc123",
"department": Department,
"departmentId": "xyz789",
"description": "abc123",
"supervisor": User,
"supervisorId": "abc123",
"title": "xyz789",
"userIds": ["xyz789"],
"users": [User]
}
UniversityInput
Fields
| Input Field | Description |
|---|---|
description -
String
|
|
locationValue -
LocationInput
|
Example
{
"description": "xyz789",
"locationValue": LocationInput
}
User
Fields
| Field Name | Description |
|---|---|
_id -
String!
|
|
brandIds -
[String]
|
|
brands -
[Brand]
|
|
configs -
JSON
|
|
configsConstants -
[JSON]
|
|
createdAt -
Date
|
|
customFieldsData -
JSON
|
|
department -
Department
|
|
details -
UserDetailsType
|
|
email -
String
|
|
emailSignatures -
JSON
|
|
getNotificationByEmail -
Boolean
|
|
groupIds -
[String]
|
|
isActive -
Boolean
|
|
isOwner -
Boolean
|
|
isShowNotification -
Boolean
|
|
isSubscribed -
String
|
|
leaderBoardPosition -
Int
|
|
links -
JSON
|
|
onboardingHistory -
OnboardingHistory
|
|
permissionActions -
JSON
|
|
score -
Float
|
|
status -
String
|
|
username -
String
|
Example
{
"_id": "abc123",
"brandIds": ["abc123"],
"brands": [Brand],
"configs": {},
"configsConstants": [{}],
"createdAt": "2007-12-03",
"customFieldsData": {},
"department": Department,
"details": UserDetailsType,
"email": "xyz789",
"emailSignatures": {},
"getNotificationByEmail": false,
"groupIds": ["xyz789"],
"isActive": true,
"isOwner": true,
"isShowNotification": true,
"isSubscribed": "xyz789",
"leaderBoardPosition": 123,
"links": {},
"onboardingHistory": OnboardingHistory,
"permissionActions": {},
"score": 987.65,
"status": "abc123",
"username": "xyz789"
}
UserConversationListResponse
Fields
| Field Name | Description |
|---|---|
list -
[Conversation]
|
|
totalCount -
Float
|
Example
{"list": [Conversation], "totalCount": 123.45}
UserDetails
Example
{
"avatar": "abc123",
"birthDate": "2007-12-03",
"description": "xyz789",
"fullName": "xyz789",
"location": "xyz789",
"operatorPhone": "abc123",
"position": "xyz789",
"shortName": "xyz789",
"workStartedDate": "2007-12-03"
}
UserDetailsType
Example
{
"avatar": "xyz789",
"birthDate": "2007-12-03",
"description": "xyz789",
"fullName": "xyz789",
"location": "xyz789",
"operatorPhone": "abc123",
"position": "abc123",
"shortName": "abc123",
"workStartedDate": "2007-12-03"
}
UsersGroup
VideoCallData
Voucher
Example
{
"_id": "xyz789",
"bonusInfo": {},
"campaign": {},
"campaignId": "abc123",
"createdAt": "2007-12-03",
"owner": {},
"ownerId": "abc123",
"ownerType": "abc123",
"status": "abc123",
"usedAt": "2007-12-03",
"voucherCampaignId": "abc123"
}
VoucherCampaign
Fields
| Field Name | Description |
|---|---|
_id -
String
|
|
attachment -
Attachment
|
|
bonusCount -
Float
|
|
bonusProductId -
String
|
|
buyScore -
Float
|
|
coupon -
String
|
|
createdAt -
Date
|
|
createdBy -
String
|
|
description -
String
|
|
discountPercent -
Float
|
|
endDate -
Date
|
|
finishDateOfUse -
Date
|
|
lotteryCampaignId -
String
|
|
lotteryCount -
Float
|
|
modifiedAt -
Date
|
|
modifiedBy -
String
|
|
productCategoryIds -
[String]
|
|
productIds -
[String]
|
|
score -
Float
|
|
scoreAction -
String
|
|
spinCampaignId -
String
|
|
spinCount -
Float
|
|
startDate -
Date
|
|
status -
String
|
|
title -
String
|
|
voucherType -
String
|
|
vouchersCount -
Int
|
Example
{
"_id": "abc123",
"attachment": Attachment,
"bonusCount": 123.45,
"bonusProductId": "xyz789",
"buyScore": 123.45,
"coupon": "abc123",
"createdAt": "2007-12-03",
"createdBy": "xyz789",
"description": "abc123",
"discountPercent": 123.45,
"endDate": "2007-12-03",
"finishDateOfUse": "2007-12-03",
"lotteryCampaignId": "xyz789",
"lotteryCount": 987.65,
"modifiedAt": "2007-12-03",
"modifiedBy": "abc123",
"productCategoryIds": ["xyz789"],
"productIds": ["xyz789"],
"score": 987.65,
"scoreAction": "abc123",
"spinCampaignId": "abc123",
"spinCount": 987.65,
"startDate": "2007-12-03",
"status": "xyz789",
"title": "abc123",
"voucherType": "xyz789",
"vouchersCount": 987
}
VoucherMain
WebSiteApp
WebSiteMessengerAppInput
ageGroupsInput
automationsTotalCountResponse
clientPortalUsersListResponse
Fields
| Field Name | Description |
|---|---|
list -
[ClientPortalUser]
|
|
totalCount -
Float
|
Example
{"list": [ClientPortalUser], "totalCount": 987.65}